This is the Postgkyl project. It is both Python library and command-line tool designed to provide unified access to Gkeyll data together with a broad variety of analytical and visualization tools.
Full documentation of the Gkeyll project is available at ReadTheDocs.
Postgkyl requires the following packages:
- adios2
- click
- matplotlib
- msgpack-python
- numpy
- pytables
- pytest
- scipy
- sympy
We recommend creating a virtual environment1 and installing the dependencies through conda:
conda env create -f environment.yml
The environment is then activated with
conda activate pgkyl
However, one can also attempt to install the dependencies directly to current
conda
environment using:
conda env update -f environment.yml
or entirely without environments:
conda install --file requirements.txt
With all the dependencies installed, both the library and the command line tool
pgkyl
can then be installed from the source with pip
:2
pip install -e .
To deactivate the environment, use
conda deactivate
Postgkyl utilizes pytest for testing. The tests can be called manually from the root Postgkyl directory simply by using:
pytest [-v]
See Gkyl License for usage conditions.
Footnotes
-
Note that
conda
needs to be initialized before environments can be used. This is the last step of theconda
installation, but the current default behavior is not to perform the initialization. It can be done afterwards usingconda init [shell name]
, e.g.,conda init fish
with the fantastic fish shell. ↩ -
As long as
conda
has been installed properly, this does not require any additional modifications ofPYTHONPATH
. If Postgkyl was used previously throughPYTHONPATH
, we strongly recommend removing the Postgkyl repository from the variable. ↩