.. QCG-PilotJob documentation master file, created by
   sphinx-quickstart on Tue Jun  2 13:16:27 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

QCG-PilotJob
============
A python service for easy execution of many tasks inside a single allocation.

.. automodule:: qcg.pilotjob.api
   :members:

.. toctree::
   :maxdepth: 1
   :caption: Basics

   overview
   installation

.. toctree::
   :maxdepth: 1
   :caption: Usage

   examples
   modes
   parallelism
   options

.. toctree::
   :maxdepth: 1
   :caption: Further reading

   concepts
   execution_environments
   execution_models
   fileinterface
   executor_api
   resourceschedulers
   resume
   performance_tools
   performance_tuning
   processes
   logs
   slurm_performance

.. toctree::
   :maxdepth: 1
   :caption: Miscellaneous

   faq
   dictionary
   license

.. toctree::
   :maxdepth: 1
   :caption: API Docs

   api/qcg.pilotjob.api
   api/qcg.pilotjob.executor_api


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


Authors
=======
| Bartosz Bosak, Piotr Kopta, Tomasz Piontek (PSNC)


Acknowledgements
================
Development and maintenance of the project has been supported by several initiatives, including:

+-----------------------------------------------------+----------------------------------------------+
| `COMPAT <https://www.compatproject.eu/>`_           | .. image:: images/logo-compat.png            |
+-----------------------------------------------------+----------------------------------------------+
| `VECMA <https://www.vecma.eu/>`_                    | .. image:: images/logo-vecma.png             |
+-----------------------------------------------------+----------------------------------------------+
| `PRACE-LAB <https://prace-lab.pl>`_                 | .. image:: images/logo-pracelab.png          |
+-----------------------------------------------------+----------------------------------------------+
| `PIONIER-LAB <https://pionier-lab.pionier.net.pl>`_ | .. image:: images/logo-pionierlab.png        |
+-----------------------------------------------------+----------------------------------------------+