On a recent linux (e.g. Ubuntu > 18.04), most requirements should be met. First install an MPI library of your choice via
sudo apt install mpich
or
brew install mpich
On mac, install gcc and python via
brew install python gcc
and make sure to follow the instructions under Caveats when installing python.
To install run
git clone --recursive git@github.com:leebr48/PyPlasmaOpt.git
or if you don't have SSH keys for GitHub set up
git clone --recursive https://github.com/leebr48/PyPlasmaOpt.git
change into the directory
cd PyPlasmaOpt/
and then depending on your platform run
make pip-mac
or make pip-linux
To check the installation
pytest tests/
Note: To use the postprocessing script (postProc.py), you will need to download ALPOpt, then create a file in PyPlasmaOpt/pyplasmaopt entitled ALPOpt_dir.txt. In this file, paste a text string containing the absolute address of the ALPOpt directory on your machine, such as /home/your_username/ALPOpt. The postprocessing script also requires STELLOPT to be installed. Finally, the logging portion of this package is meant to interact with SLURM - you may get odd results if you call Python directly from the command line.