index.rst 2.42 KB
Newer Older
Brandon Walts's avatar
Brandon Walts committed
1 2 3 4 5
.. ehive_user_manual documentation master file, created by
   sphinx-quickstart on Thu Dec 15 12:59:35 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

6 7
.. Have a look at https://raw.githubusercontent.com/rtfd/readthedocs.org/master/docs/index.rst for inspiration

8 9
Welcome to the eHive user manual
================================
Brandon Walts's avatar
Brandon Walts committed
10

11
This manual describes how to run, develop, and troubleshoot eHive pipelines. It describes eHive's "swarm of autonomous agents" paradigm, shows how different components work together, and provides code examples. There are also links to API documentation for eHive classes.
12 13 14

The code is open source, and `available on GitHub`_.

Matthieu Muffato's avatar
Matthieu Muffato committed
15
.. _available on GitHub: https://github.com/Ensembl/ensembl-hive
16 17 18 19 20 21 22 23 24 25

The main documentation for eHive is organized into a couple sections:

* :ref:`user-docs`
* :ref:`dev-docs`

.. _user-docs:

User documentation
==================
Brandon Walts's avatar
Brandon Walts committed
26 27

.. toctree::
28 29 30 31
   :caption: Quickstart

   quickstart/install
   quickstart/quickstart
Brandon Walts's avatar
Brandon Walts committed
32

33 34 35 36
.. toctree::
   :caption: Walkthrough

   walkthrough/long_mult_walkthrough
37 38

.. toctree::
39
   :caption: Running pipelines
40

41
   running_pipelines/initializing
42 43 44
   running_pipelines/running
   running_pipelines/monitoring
   running_pipelines/management
Brandon Walts's avatar
Brandon Walts committed
45
   running_pipelines/tweaking
Brandon Walts's avatar
Brandon Walts committed
46
   running_pipelines/error-recovery
47
   running_pipelines/troubleshooting
48 49 50


.. toctree::
51 52 53 54 55
   :caption: Creating pipelines

   creating_pipelines/events
   creating_pipelines/dataflows
   creating_pipelines/dataflow_targets
56
   creating_pipelines/accumulators
Matthieu Muffato's avatar
Matthieu Muffato committed
57
   creating_pipelines/parameters
58
   creating_pipelines/semaphores
59
   creating_pipelines/pipeconfigs
60
   creating_pipelines/included_runnables
61

Brandon Walts's avatar
Brandon Walts committed
62

63
.. toctree::
64 65
   :caption: Creating runnables

66 67
   creating_runnables/runnables_overview
   creating_runnables/IO_and_errors
Brandon Walts's avatar
Brandon Walts committed
68 69


70
.. toctree::
71 72 73 74
   :caption: Advanced usage

   advanced_usage/mpi
   advanced_usage/slack
75
   advanced_usage/continuous_pipelines
76 77


78
.. toctree::
79
   :caption: Appendix
80 81
   :maxdepth: 1

82
   appendix/presentations
83
   appendix/analyses_pattern
84
   appendix/scripts
85
   appendix/hive_schema
86
   appendix/api
87
   appendix/changelog
88 89 90 91 92 93 94


.. _dev-docs:

Developer documentation
=======================

95
.. toctree::
96
   :caption: Developer documentation
97

98
   dev/development_guidelines
99
   dev/release_checklist
100
   dev/build_the_docs
101 102


Brandon Walts's avatar
Brandon Walts committed
103 104 105 106 107 108 109
Indices and tables
==================

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

110 111

..  LocalWords:  api