Installation

The oimodeler package can be installed directly using the pip install command:

$ pip install git+https://github.com/oimodeler/oimodeler

Warning

The examples and their dedicated data are not installed via pip. They are available for manual download on the GitHub archive.

Alternatively, we recommend installing the full oimodeler package (including examples and data) by cloning the GitHub repository:

$ git clone https://github.com/oimodeler/oimodeler
$ cd oimodeler/

and installing it as a non-editable package:

$ pip install .

Or as an editable (development) install:

$ pip install -e .

Dependencies

The oimodeler package requires the following dependencies:

• numpy

• scipy

• matplotlib

• astropy

• astroquery

• emcee

• corner

• tqdm

• pyFFTW (optional)

• dynesty (optional)

For development, the following optional packages might be useful:

• pytest

• pytest-cov

• sphinx

• sphinx-autobuild

• sphinx-autodoc-typehints

• sphinx_rtd_theme

• numpydoc

Except for development dependencies, these packages are automatically installed if missing when installing oimodeler via pip.

Checking Installation

To check if oimodeler is properly installed, run the Getting Started guide or try some examples from the The basics of oimodeler section.