File: index.rst

package info (click to toggle)
ecflow 5.15.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 51,868 kB
  • sloc: cpp: 269,341; python: 22,756; sh: 3,609; perl: 770; xml: 333; f90: 204; ansic: 141; makefile: 70
file content (53 lines) | stat: -rw-r--r-- 1,515 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

..
   This is the documentation for ecFlow, a workflow management system developed by ECMWF.
   The documentation is built using Sphinx and, by convention, we use the following heading markup in our reStructuredText files:
 
     ******************************************** (h1)
     ============================================ (h2)
     -------------------------------------------- (h3)
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ (h4)
     """""""""""""""""""""""""""""""""""""""""""" (h5)
     '''''''''''''''''''''''''''''''''''''''''''' (h6)

Welcome to ecFlow's documentation
*********************************

.. image:: /_static/overview/image1.png
   :width: 300px

*ecFlow* is a client/server workflow package that enables users to run a large number of programs (with dependencies on each other and on time) in a controlled environment. It provides tolerance for hardware and software failures, combined with restart capabilities. It is used at ECMWF to run all our operational suites across a range of platforms.

.. toctree::
   :maxdepth: 1
   :caption: Documentation

   overview
   quickstart.rst
   tutorial/tutorial.rst
   client_api/index.rst
   python_api/python_api.rst
   rest_api.rst
   udp_api.rst
   ug/index.rst
   glossary.rst
   faq

.. toctree::
   :maxdepth: 1
   :caption: Installation

   install/index.rst
   release_notes/index.rst
   support
   contributing
   licence


Indices and tables
******************

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