Installation

p-winds requires the packages numpy, scipy, astropy, and flatstar for running its core calculations. For hydrodyamic simulations with the ATES wrapper, p-winds also requires a Fortran compiler (either gfortran or ifort) and a custom version of the ATES code available for download here.

Option 1: Using pip (stable version)

Simply run the following command:

pip install p-winds

Option 2: Compile from source (development version)

First, clone the repository and navigate to it:

git clone https://github.com/ladsantos/p-winds.git && cd p-winds

And then compile p-winds from source:

python setup.py install

You can test the installation from source with pytest (you may need to install pytest first):

pytest tests

Download the custom ATES code and set environment variable

If you wish to use the ATES wrapper available in the fluid module, you will need to download a custom ATES code here. The wrapper is not compatible with the original ATES code.

After downloading it, you will need to set the environment variable $ATES_DIR to the location of the ATES code in your computer. For this example, I will use $HOME/ATES-Code. This is done by running the following code in the command line:

export ATES_DIR="$HOME/ATES-Code"

If you do not want to set this environment variable every time you start a new session, you can add this line to your Record Columnar file (or rc) in your user folder. Usually, this file is ~/.bashrc if you use a bash shell, or ~/.zshrc if you use zshell.

Download reference spectra and set environment variable

If you want to use the function tools.generate_muscles_spectrum() or tools.standard_spectrum(), you will need to download the reference data separately and set the environment variable $PWINDS_REFSPEC_DIR. For your convenience, you can download all spectra supported by p-winds in this compressed file.

After unzipping the compressed file, move the fits files to a path of your choosing; in this example, I will use the path /$HOME/Data/p-winds_reference_spectra. Next, set an environment variable $PWINDS_REFSPEC_DIR that points to this path; this is done by running the following code in the command line:

export PWINDS_REFSPEC_DIR="$HOME/Data/p-winds_reference_spectra"

If you do not want to set this environment variable every time you start a new session, you can add this line to your Record Columnar file (or rc) in your user folder. Usually, this file is ~/.bashrc if you use the bash shell, or ~/.zshrc if you use the z-shell.