Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
hopla 2.0.0 documentation
Logo
hopla 2.0.0 documentation
  • Quickstart
  • Examples
    • Basic example on how to use the CCC cluster
    • Basic example on how to use the CCC cluster using multi-tasks
    • Basic example on how to use the CCC cluster using multi-tasks
    • Basic example on how to use the CCC cluster using multi-tasks
    • Basic example on how to use the PBS cluster
    • Basic example on how to use the SLURM cluster
  • User guide
    • 1. What is hopla
    • 2. Introduction
    • 3. How It Works
    • 4. Clusters
    • 5. CLI
  • API References
    • hopla.ccc: Contains PBS specific functions.
      • hopla.ccc.CCCInfoWatcher
      • hopla.ccc.DelayedCCCJob
    • hopla.cli:
      • hopla.cli._strip_ansi
      • hopla.cli.main
      • hopla.cli.print_header
      • hopla.cli.print_toml
    • hopla.config: Configuration used by hopla.
      • hopla.config.Config
    • hopla.executor: Contains job execution functions.
      • hopla.executor.DelayedSubmission
      • hopla.executor.Executor
    • hopla.pbs: Contains PBS specific functions.
      • hopla.pbs.DelayedPbsJob
      • hopla.pbs.PbsInfoWatcher
    • hopla: hopla can automate job creation, submission, monitoring, and resubmission,
      • hopla.DelayedSubmission
      • hopla.Executor
    • hopla.slurm: Contains SLURM specific functions.
      • hopla.slurm.DelayedSlurmJob
      • hopla.slurm.SlurmInfoWatcher
    • hopla.utils: Contains some utility functions.
      • hopla.utils.DelayedJob
      • hopla.utils.InfoWatcher
      • hopla.utils.JobPaths
      • hopla.utils.find_stack_level
      • hopla.utils.format_attributes
  • API Search

Development

  • Contributing
  • Continuous integration
  • Maintenance
  • Changelog
  • People
  • License
  • Versions
Back to top
View this page
Edit this page

User guide¶

This user guide is especially directed towards grad students with a background in computer science. However, less or more advanced readers can also find interesting pieces of information throughout the guide.

Table of contents¶

  • 1. What is hopla
  • 2. Introduction
  • 3. How It Works
  • 4. Clusters
    • 4.1. SLURM
    • 4.2. PBS
    • 4.3. CCC
  • 5. CLI
    • 5.1. Usage
    • 5.2. Workflow
    • 5.3. TOML Configuration
      • 5.3.1. [project]
      • 5.3.2. [inputs]
      • 5.3.3. [environment]
      • 5.3.4. [config]
      • 5.3.5. [multi] (optional)
    • 5.4. Notes
Next
1. What is hopla
Previous
Basic example on how to use the SLURM cluster
Copyright © The hopla developers.
Made with Sphinx and @pradyunsg's Furo
On this page
  • User guide
    • Table of contents