Getting Started

Installation

It is reccomended to install the package in a virtual environment.

venv

# python version depends
# on the globally installed python
python -m venv sunflare-env

venv\Scripts\activate

# for Windows...
# ... command prompt
venv\Scripts\activate.bat

# ... powershell
venv\Scripts\Activate.ps1

conda

conda create -n redsun-env python=3.9
conda activate redsun-env

mamba

mamba create -n redsun-env python=3.9
mamba activate redsun-env

You can install the package from PyPI or directly from the GitHub repository.

PyPI

pip install -U sunflare

GitHub

git clone https://github.com/redsun-acquisition/sunflare.git
cd sunflare
pip install -e .

Usage from source

Building the documentation

If you want to build the documentation locally, you’ll need to install the dependencies first:

pip install -e .[doc]

You can build the documentation by running the following command:

cd docs
make html

# for windows
make.bat html

And then open the _build/html/index.html file in your browser.

Running tests

To run the tests, you’ll need to install the dependencies first:

pip install -e .[dev]

Then, you can run the tests by running the following command:

pytest

You can also obtain a test coverage report by running the following command:

pytest --cov=sunflare --cov-report=html

This will generate a htmlcov directory with the test coverage report, which you can open in your browser by opening the index.html file.