Xboinc

Contents:

  • 1. Xboinc
  • 2. How to use Xboinc
    • 2.1. Install Xboinc
    • 2.2. Subscribe to the Xboinc submitter e-group
    • 2.3. Allocate a folder and register your username under the Xboinc server
      • 2.3.1. Folder in AFS
      • 2.3.2. Folder in EOS
    • 2.4. Submit a job
    • 2.5. Retrieve the results
    • 2.6. Check your subscription and jobs status
  • 3. API Reference
    • 3.1. xboinc
      • 3.1.1. Submodules
        • 3.1.1.1. xboinc.df_wu
        • 3.1.1.2. xboinc.executable
        • 3.1.1.3. xboinc.general
        • 3.1.1.4. xboinc.register
        • 3.1.1.5. xboinc.retrieve
        • 3.1.1.6. xboinc.server
        • 3.1.1.7. xboinc.simulation_io
        • 3.1.1.8. xboinc.submit
        • 3.1.1.9. xboinc.user
      • 3.1.2. Attributes
      • 3.1.3. Classes
      • 3.1.4. Functions
      • 3.1.5. Package Contents
        • check_user_subscription()
        • query_registered_work_units()
        • generate_executable()
        • generate_executable_source()
        • __version__
        • __xsuite__versions__
        • _pkg_root
        • deregister()
        • register()
        • ResultRetriever
        • XbInput
        • XbState
        • app_version
        • app_version_int
        • assert_versions()
        • JobManager
        • _skip_xsuite_version_check
Xboinc
  • 3. API Reference
  • View page source

3. API Reference

This page contains auto-generated API reference documentation [1].

  • 3.1. xboinc
    • 3.1.1.1. xboinc.df_wu
    • 3.1.1.2. xboinc.executable
      • 3.1.1.2.1.1. xboinc.executable.generate
    • 3.1.1.3. xboinc.general
    • 3.1.1.4. xboinc.register
    • 3.1.1.5. xboinc.retrieve
    • 3.1.1.6. xboinc.server
      • 3.1.1.6.1.1. xboinc.server.paths
      • 3.1.1.6.1.2. xboinc.server.tools
    • 3.1.1.7. xboinc.simulation_io
      • 3.1.1.7.1.1. xboinc.simulation_io.default_tracker
      • 3.1.1.7.1.2. xboinc.simulation_io.input
      • 3.1.1.7.1.3. xboinc.simulation_io.output
      • 3.1.1.7.1.4. xboinc.simulation_io.version
    • 3.1.1.8. xboinc.submit
    • 3.1.1.9. xboinc.user
[1]

Created with sphinx-autoapi

Previous Next

© Copyright 2025, Frederik F. Van der Veken, Carlo E. Montanari, Davide Di Croce, Giovanni Iadorala.

Built with Sphinx using a theme provided by Read the Docs.