.. VORTEX documentation master file

*vortex* |version| documentation
================================

Welcome!

*vortex* is a Python library that facilitates writing scripts for
computational jobs in Numerical Weather Prediction (NWP).

It provides functions to

- Fetch and cache data from an archive.
- Execute sequential and parallel programs using the fetched data.
- Write and cache data generated by programs to an archive.

*vortex* also provides ways of tracking fetched and generated data,
making it easy to implement pre or post-processing operations.

Installation
------------

*vortex* is available on `pypi.org <https://pypi.org/project/vortex-nwp>`_.

It can be installed using ``pip`` or similar tools:

.. code:: 

   pip install vortex-nwp


Contents
--------

.. toctree::
   :maxdepth: 1

   Tutorial <tutorial/fetch>
   User guide <user-guide/index>
   Reference <reference/index>