Installation

Requirements

vplanet_inference requires Python 3.7+ and the following dependencies (installed automatically):

Setting up a conda environment

It is recommended to install vplanet_inference in a dedicated conda environment to avoid dependency conflicts. If you don’t have conda, install it via Miniconda or Anaconda.

Create and activate a new environment with Python 3.7+:

conda create -n vpi python=3.10
conda activate vpi

Installing vplanet_inference

Clone the repository and install with pip:

git clone https://github.com/jbirky/vplanet_inference
cd vplanet_inference
pip install -e .

Or install using setup.py:

git clone https://github.com/jbirky/vplanet_inference
cd vplanet_inference
python setup.py install

Optional dependency: alabi

The AnalyzeVplanetModel class supports surrogate-model-accelerated MCMC via the alabi package. To enable this functionality:

git clone https://github.com/jbirky/alabi
cd alabi
python setup.py install

Verifying the installation

import vplanet_inference as vpi
print(vpi.INFILE_DIR)   # path to bundled template infiles