Installation
The below will help you quickly install pytreegrav.
Requirements
You will need a working Python 3.x installation; we recommend installing Anaconda Python version 3.x. You will also need to install the following packages:
numpy
numba
Installing the latest stable release
Install the latest stable release with
pip install pytreegrav
This is the preferred way to install pytreegrav as it will
automatically install the necessary requirements and put Pytreegrav
into your ${PYTHONPATH}
environment variable so you can
import it.
Install from source
Alternatively, you can install the latest version directly from the most up-to-date version of the source-code by cloning/forking the GitHub repository
git clone https://github.com/mikegrudic/pytreegrav.git
Once you have the source, you can build pytreegrav (and add it to your environment) by executing
python setup.py install
or
pip install -e .
in the top level directory. The required Python packages will automatically be installed as well.
You can test your installation by looking for the pytreegrav executable built by the installation
which pytreegrav
and by importing the pytreegrav Python frontend in Python
import pytreegrav
Testing
To test that the tree solver is working correctly, run
pytest
from the root directory of the package. This will run a basic test problem comparing the acceleration and potential from the tree and brute force solvers respectively, and check that the answers are within the expected tolerance.