index.rst 1.24 KB
Newer Older
Marco Govoni's avatar
Marco Govoni committed
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
.. westpy documentation master file
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to westpy's documentation!
==================================

.. .. important::

    This is documentation for the **westpy** *package*, which is part of the WEST_ framework.

.. _WEST: http://www.west-code.org

Contents
--------

.. toctree::
   :hidden:
   :maxdepth: 2

   overview
   installation
   tutorial  
   manual
   acknowledge

.. glossary::

    :ref:`overview`
      An illustration of **westpy**.

    :ref:`installation`
      Instructions on how to install the **westpy** package.

    :ref:`Tutorial`
      Compact demonstration of usage of **westpy** for pre- and post-processing WEST calculations.

    :ref:`manual`
      The complete reference.

    :ref:`acknowledge`
      Instructions on how to acknowledge this software in publications.

.. note::

   To get help using the **westpy** package, send an email to `mgovoni@anl.gov <mailto:mgovoni@anl.gov>`_.

The **westpy** package is hosted on `GitLab <http://greatfire.uchicago.edu/west-public/westpy>`_, mirrored to `GitHub <https://github.com/west-code-development/westpy>`_, and licensed under the open-source GPLv3 license.