:mod:`lab.experiment` --- Create experiments
============================================

.. module:: lab.experiment

:class:`Experiment`
-------------------

.. autoclass:: Experiment
   :members:
   :undoc-members:
   :inherited-members:



Custom command line arguments
.............................

.. data:: ARGPARSER

   `ArgumentParser <http://docs.python.org/library/argparse.html>`_
   instance that can be used to add custom command line arguments.
   You can import it, add your arguments and call its ``parse_known_args()``
   method to retrieve the argument values. To avoid confusion with step
   names you shouldn't use positional arguments.

   .. note::

        Custom command line arguments are only passed to locally
        executed steps.

   ::

        from lab.experiment import ARGPARSER

        ARGPARSER.add_argument(
            "--tex", action="store_true", help="produce LaTeX output"
        )

        args = ARGPARSER.parse_known_args()
        if args.tex:
            print("writing LaTeX output")
        else:
            print("writing HTML output")


:class:`Run`
------------

.. autoclass:: Run
   :members:
   :undoc-members:
   :inherited-members:
   :exclude-members: build


:class:`CachedRevision`
-----------------------

.. autoclass:: lab.cached_revision.CachedRevision
   :members:
   :undoc-members:
   :inherited-members:


.. _parsing:

:class:`Parser`
---------------

.. autoclass:: lab.parser.Parser
   :members:
   :undoc-members:


.. _environments:

:class:`Environment`
--------------------

.. autoclass:: lab.environments.Environment

Lab supports several built-in environments below. Additionally, support for
`HTCondor <https://htcondor.org/>`_ clusters is provided by a `third-party
repository <https://github.com/Martin1887/lab-htcondor-environment>`_.

.. autoclass:: lab.environments.LocalEnvironment
.. autoclass:: lab.environments.SlurmEnvironment
   :members: is_present
.. autoclass:: lab.environments.ArrheniusEnvironment
.. autoclass:: lab.environments.BaselSlurmEnvironment
.. autoclass:: lab.environments.TetralithEnvironment


Various
-------

.. autodata:: lab.__version__
   :annotation: