Welcome to the lemmings documentation. The reference to the dumb character of the awesome 1991 game (DMA Design,/Psygnosis) is intentional : HPC workflows of multiple interdependant runs easily produce unnecessary or failed runs. The package lemmings can help … under the supervision of the user!

• Lemmings
  • Idea
  • Installation
  • End user POV
  • Creating a workflow
  • Resources
  • Acknowledgements
• Tutorials
  • Getting started
    • Read the tutorials
    • Set up your machine configuration
    • Create a simple recursive workflow
    • Try (and correct)
  • Lemmings commands
    • Recursive workflows commands
    • Farming workflows commands
• How-to Guides
  • The SandBox Tutorial
    • Main commands
      • Start the sandbox
      • Submit a job
      • Check the queuing status
      • Cancel a job
      • Accounting
    • Minimal tutorial
    • How does it work?
    • Known limitations
  • The SandCastle Tutorial
    • The mock solver twicer
    • Create a workflow for twicer
      • The Prepare run code
      • The Check on end code
      • Gathering this into a single workflow
    • Testing the workflow
      • Start lemmings
      • Monitor during the run
      • Look at the result
      • Replay
    • Improve the workflow
      • Add a custom parameter in the input file
      • Prevent job submission if workflow was already completed
      • Provide a progression information to lemmings
    • Takeaways
  • The SandCastle Farming Tutorial
    • A code with a parameter changing its output.
    • Create a workflow for farming
      • Replicate the workflow four times
      • Using the Farming CLI to create the farming structure
      • Adapt your workflow to a farming
      • Try the farming workflow … for real
    • Improve the workflow
      • A workflow for both farming and single runs
      • A farming based on an external file
    • Takeaway
• References
  • lemmings package
    • Subpackages
      • lemmings.chain package
      • lemmings.sandbox package
    • Submodules
    • lemmings.cli module
    • lemmings.cli_farming module
    • lemmings.cli_helper module
    • lemmings.cli_status module
      • customise_end_message()
      • get_current_status()
      • parallel_status()
• Explanations
  • Lemmings Machine
    • Create your Machine configuration {machine}.yml
  • Workflow
    • The configuration {workflow_name}.yml
    • The script {workflow_name}.py
  • Principles of lemmings
    • A) Lemmings must behave like any human user
    • B) Lemmings must stay non-intrusive**
    • C) Lemmings must not replace pre-existing services**.
  • Limits of lemmings
    • Lemming is no more allowing restarts without resets
    • Lemming will not tidy up your folders for you
    • Lemmings is not a simulation monitoring system
    • Lemmings is no more a CPU-consumption limiter
  • Coming soon
    • Refactoring of PathTools
    • Farming : use symbolic links for folder replication
    • File lock in the sandbox
    • A dumber Lemmings clean
    • Tests on sandbox itself, clean and kill
• Changelog
  • [0.8.1] 2023 / 01 / 30
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.8.0] 2022 / 6 / 23
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.7.0] 2022 / 5 / 13
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.6.0] 2021 / 10 / 4
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.5.0] 2021 / 09 / 3
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.4.4] 2021 / 08 / 27
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.4.3] 2021 / 08 / 24
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.4.2] 2021 / 08 / 20
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.4.1] 2021 / 08 / 20
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.4.0] 2021 / 08 / 19
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.3.0] 2021 / 07 / 9
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.2.3] 2021 / 05 / 7
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.2.2] 2021 / 04 / 27
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.2.1] 2021 / 04 / 14
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.2.0] 2021 / 04 / 13
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.1.0] 2020 / 07 / 01
    • Added
    • Changed
    • Fixed
    • Deprecated
  • [0.0.1] 2020 / 06 / 20

Lemmings documentation

• Index

• Module Index

• Search Page