index.rst 2.53 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
   :caption: Creating pipelines

53
   creating_pipelines/pipeconfigs
54
   creating_pipelines/dataflows
55
   creating_pipelines/semaphores
56
   creating_pipelines/accumulators
Matthieu Muffato's avatar
Matthieu Muffato committed
57
   creating_pipelines/parameters
58
   creating_pipelines/meadows_and_resources
59
   creating_pipelines/included_runnables
60

Brandon Walts's avatar
Brandon Walts committed
61

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

65
   creating_runnables/runnables_overview
66
   creating_runnables/runnable_api
67
   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 79
.. toctree::
   :caption: External plugins

80
   contrib/alternative_meadows
81
   contrib/docker-swarm
82

83
.. toctree::
84
   :caption: Appendix
85 86
   :maxdepth: 1

87
   appendix/presentations
88
   appendix/analyses_pattern
89
   appendix/scripts
90
   appendix/hive_schema
91
   appendix/api
92
   appendix/changelog
93 94 95 96 97 98 99


.. _dev-docs:

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

100
.. toctree::
101
   :caption: Developer documentation
102

103
   dev/development_guidelines
104
   dev/release_checklist
105
   dev/build_the_docs
106 107


Brandon Walts's avatar
Brandon Walts committed
108 109 110 111 112 113 114
Indices and tables
==================

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

115 116

..  LocalWords:  api