Installation

It is recommended to install h-emcee into a virtual environment (for example, using conda).

Installation using pip

For a quick start, use pip to install:

python -m pip install h-emcee

The backend uses JAX, which is installed automatically with pip. For GPU users, this will auto-install a CPU-only version of JAX. For an installation with GPU support, please see https://docs.jax.dev/en/latest/installation.html

For GPU users, install the latest version of JAX with GPU support:Installation using pip

Installation from source

git clone https://github.com/clarkmiyamoto/hemcee.git
cd hemcee
pip install -e .

The -e (“editable”) install is handy if you’re iterating on the code locally.

Developer Installation

It’s recommended to make a fork of the repo, clone the fork, and install the package in editable mode with the dev extras.

pip install -e ".[dev]"

Verify Installation

You can verify the installation is working by running:

python
>>> import hemcee
>>> print(hemcee.__version__)

You can also verify installation is working as intended by running the test suite. We use pytest:

python -m pip install pytest

After installing, run all tests:

cd tests
python -m pytest