Installation

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

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

Warning

The examples including dedicated data won’t be installed when using pip in this way. They are available on the Github archive for manual download.

Alternatively, you can install the complete 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 install:

$ pip install .

Or as an editable (development) install:

$ pip install -e .

Dependancies

The oimodeler package requires the following packages:

• numpy

• scipy

• matplotlib

• astropy

• astroquery

• emcee

• corner

• tqdm

• pyFFTW (optional)

And for development some optional packages might be useful:

• pytest

• pytest-cov

• sphinx

• sphinx-autobuild

• sphinx-autodoc-typehints

• sphinx_rtd_theme

• numpydoc

These packages (except the development dependencies) are automatically installed if missing when installing oimodeler.

Checking installation

The check if oimodeler is properly installed you can run the Getting Started or other Examples scripts.