Metadata-Version: 2.4
Name: tifuun-sensitivity
Version: 0.1.7
Summary: Sensitivity calculator for TIFUUN
License: MIT
License-File: LICENSE
Author: Arend Moerman
Author-email: a.moerman-1@tudelft.nl
Requires-Python: >=3.10,<3.14
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: jupyter-io (>=1.0)
Requires-Dist: matplotlib (>=3.8)
Requires-Dist: numpy (>=1.26)
Requires-Dist: pandas (>=2.2)
Requires-Dist: scipy (>=1.13)
Description-Content-Type: text/markdown

# tifuun-sensitivity

Sensitivity calculator for TIFUUN-type spectrometers

## Overview

`tifuun-sensitivity` is a Python package which enables to calculate observation sensitivity of TIFUUN-type spectrometers.
Currently it is mainly used to estimate the observation sensitivity of TIFUUN.

## Requirements

- **Python:** 3.11 (tested by the authors)
- **Dependencies:** See [pyproject.toml](https://github.com/tifuun/tifuun-sensitivity/blob/main/pyproject.toml)
- **Optional dependencies:** 
    - `nose2` for running the unittests

## Installation
### From PyPI
Simply run:
```shell
pip install tifuun-sensitivity
```
This will install the most recent version on PyPI.

### From source
After cloning, navigate to the directory containing this README and run:
```shell
pip install .
```

## How to use it
Please have a look at the "Basics of running tifuun-sensitivity" notebook in the `/ipynb/` folder.

