Commit d7139504 authored by Marco Govoni's avatar Marco Govoni

Introduced See Also

parent bdc3f465
......@@ -3,7 +3,7 @@
Credits
=======
The development of **westpy** is funded by `MICCoM <http://miccom-center.org/>`_, as part of the CMS Program funded by the U.S. DOE-BES.
The development of **WESTpy** is funded by `MICCoM <http://miccom-center.org/>`_, as part of the CMS Program funded by the U.S. DOE-BES.
Project Lead
......
......@@ -2,12 +2,12 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to westpy's documentation!
Welcome to WESTpy's documentation!
==================================
.. .. important::
This is documentation for the **westpy** *package*, which is part of the WEST_ framework.
This is documentation for the **WESTpy** *package*, which is part of the WEST_ framework.
.. _WEST: http://www.west-code.org
......@@ -27,13 +27,13 @@ Contents
.. glossary::
:ref:`overview`
An illustration of **westpy**.
An illustration of **WESTpy**.
:ref:`installation`
Instructions on how to install the **westpy** package.
Instructions on how to install the **WESTpy** package.
:ref:`Tutorial`
Compact demonstration of usage of **westpy** for pre- and post-processing WEST calculations.
Compact demonstration of usage of **WESTpy** for pre- and post-processing WEST calculations.
:ref:`manual`
The complete reference.
......@@ -43,7 +43,7 @@ Contents
.. note::
To get help using the **westpy** package, send an email to `mgovoni@anl.gov <mailto:mgovoni@anl.gov>`_.
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.
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.
......@@ -4,7 +4,7 @@
Installation
============
The recommendend installation method for **westpy** is via python install.
The recommendend installation method for **WESTpy** is via python install.
The software is tested for python version 3.x and has the following dependencies:
- ``numpy``
......@@ -13,11 +13,12 @@ The software is tested for python version 3.x and has the following dependencies
- ``datetime``
- ``requests``
- ``mendeleev``
- ``signac``
Source Code Installation
========================
To install **westpy** you need to execute:
To install **WESTpy** you need to execute:
.. code:: bash
......
......@@ -3,7 +3,7 @@
Manual
======
The complete **westpy** manual.
The complete **WESTpy** reference is reported below.
Units
......
......@@ -3,13 +3,13 @@
Overview
========
**westpy** is designed to assist users of the WEST code in pre- and post-processing operations.
**WESTpy** is designed to assist users of the **WEST** code in pre- and post-processing operations.
Features:
- Guided generation of input files for ground state density functional theory calculations (Qbox, QuantumEspresso)
- Guided generation of input filed for WEST
- Guided generation of input filed for **WEST**
- Plot of DOS, LDOS, full-frequency self-energy
.. note::
`WEST <http://www.west-code.org/doc/West/latest/>`_ is massively parallel code for Many-Body Perturbation Theory calculations.
.. seealso::
**WEST** is massively parallel code for Many-Body Perturbation Theory calculations. Click `here <http://www.west-code.org/doc/West/latest/>`_ to know more.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment