README.adoc

MIRITools

Table of Contents

• 1. Introduction
• 2. Installation
• 3. Documentation

1. Introduction

The "miritools" package contains convenience functions usefull to display or characterize MIRI data on board JWST. Some are more generic and could be usefull in general, but all of them have been created with MIRI in mind in some way or another.

Miritools start at v4.0.0. This is for historical reasons because it is based on the miricap package and I kept the version number for convenience.

2. Installation

The easiest way to install the latest miritools release into a fresh virtualenv or conda environment is

pip install miritools

3. Documentation

Documentation is available at:

https://miritools.readthedocs.io/en/latest/

To build the docs yourself, clone this repository and build the documentation with:

pip install -e ".[docs]"
cd docs
make html
make latexpdf