Installation
To install the OrbDot package, you have different options depending on your environment and preferences. Before installing OrbDot, it is recommended to create and activate a virtual environment using venv to prevent dependency conflicts.
Using pip
The recommended way to install the stable version of OrbDot is using pip:
pip install orbdot
This will download and install the latest release and its dependencies.
Installing a Local Copy
You can also install OrbDot directly from a local copy of the source code.
First, clone the OrbDot repository:
git clone https://github.com/simonehagey/orbdot.git
Next, navigate into the project directory and install the package:
cd orbdot
python -m pip install .
Test the Installation
To ensure that the installation was successful, run an example script.
If you installed OrbDot from a local copy, navigate to the examples/ directory and execute the example_wasp12.py script:
cd orbdot/examples
python example_wasp12.py
If you installed via pip, you will first need to download the /examples directory from the GitHub repository or by clicking this link.
If the model fitting process starts successfully, the installation was successful!
Dependencies
OrbDot requires Python 3.9 or higher and depends on the following libraries:
astropy (>=5.1.1) [Astropy Collaboration et al., 2018]
corner (>=2.2.1) [Foreman-Mackey, 2016]
matplotlib (>=3.6.0) [Hunter, 2007]
nestle (>=0.2.0) [Barbary, 2021]
numpy (>=1.24.0) [Harris et al., 2020]
scipy (>=1.13.0) [Virtanen et al., 2020]
Additional optional dependencies:
PyMultiNest by Johannes Buchner [Buchner et al., 2014, Buchner, 2016], a Python interface for MultiNest [Feroz et al., 2009, Feroz et al., 2019].
Note
When using the nested sampling methods [Skilling, 2006, Feroz and Hobson, 2008] the users can choose between two packages: Nestle and PyMultiNest. PyMultiNest is generally faster and more robust, but it can be difficult to install. Therefore, it is not required for using OrbDot.
Nestle is included as a dependency and will be installed automatically. In order to use PyMultiNest, you will have to follow their installation instructions here after setting up OrbDot.