Tutorials

These are the fastest guides to learn about this package. Go there if you are in a hurry.

• 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

These are the step-by-step guides to see a practical usage of this package. Read this to learn by examples.

• The SandBox Tutorial
  • Main commands
  • Minimal tutorial
  • How does it work?
  • Known limitations
• The SandCastle Tutorial
  • The mock solver twicer
  • Create a workflow for twicer
  • Testing the workflow
  • Improve the workflow
  • Takeaways
• The SandCastle Farming Tutorial
  • A code with a parameter changing its output.
  • Create a workflow for farming
  • Improve the workflow
  • Takeaway

References

This the exhaustive api description ressource.

• lemmings package
  • Subpackages
  • Submodules
  • lemmings.cli module
  • lemmings.cli_farming module
  • lemmings.cli_helper module
  • lemmings.cli_status module

Explanations

This is where you will find some in-depth explanation. If your question starts with “why ?”, the answer is probaly here.

• 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