pypStag

A python package for post-processing and analysing StagYY outputs.

pypStag is a python package providing a set of tools and data structures to efficiently analyse the binary outputs generated by the mantle convection code StagYY.

Install pypStag:

1. Download

Download pypStag from this page and unzip the archive. Then, move into the main directory of the package:

cd pypStag-master/

2. Linking pypStag

To link in a user module directory, use pip and run:

python -m pip install .

Uninstall pypStag:

As you used pip for the installation, use it to uninstall the package. In a terminal, run:

pip uninstall pypStag

Cite pypStag.

You can cite pypStag using the following APA style citation (update de commit ID):

Janin, A. (2025). pypStag: A python package for post-processing and analysing StagYY outputs. GitHub. https://github.com/AlexandrePFJanin/pypStag (commit XXXXXXX)

Or with the following bibTeX citation (update de commit ID):

@misc{pypStag,
  author       = {Janin, Alexandre},
  title        = {pypStag: A python package for post-processing and analysing StagYY outputs.},
  year         = {2025},
  howpublished = {\url{https://github.com/AlexandrePFJanin/pypStag}},
  note         = {commit XXXXXXX}
}