index.rst

timewise: Build IR Lightcurve from WISE data

Installation

timewise is currently supported with python 3.10.

Using poetry (RECOMMENDED)

We recommend using poetry for python installation to properly resolve all dependencies (see this for more info).

If you are using poetry to manage your python environment you can install timewise like this:

poetry add timewise

If you want to install timewise in editable mode just clone the repository and execute this in the timewise root directory

poetry install

Using pip

pip install timewise

If you would like to install in editable mode just clone the repository and execute this in the timewise root directory:

pip install -e

Note that the requirements.txt was deprecated in v0.1.9. The easiest way to install the dependencies is to install via poetry.

Dependencies for showing SDSS cutouts

There is one package that does not obey! It's SciServer! It's used to access SDSS data and plot cutouts. If you want to use this functionality install this and create an account here. As soon as required you will be required to enter your username and password.

Testing

You can verify that everything is working (because this package is flawless and works everywhere.) by executing the unittest

python -m unittest discover tests/

Usage

How you want to access timewise depends on your use case. If you want to use the functionality off the shelf, head over to the CLI. If you want to do more involved things or embed timewise in your code, check out the usage of the Classes directly.

Cite

If you use timewise please cite this

CONTENTS

.. toctree::
   installation
   cli
   getting_started
   api
   :maxdepth: 1