Metadata-Version: 2.4
Name: hawcsimulator
Version: 2026.10.0
Summary: HAWCsat simulator package
Author-email: Daniel Zawada <daniel.zawada@usask.ca>
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: pandas
Requires-Dist: xarray
Requires-Dist: astropy
Requires-Dist: sasktran2>=2026.10.1
Requires-Dist: netcdf4
Requires-Dist: appdirs
Requires-Dist: pyyaml
Requires-Dist: packaging
Requires-Dist: numba>0.55
Requires-Dist: aliprocessing>=2026.10.0
Requires-Dist: skretrieval>=2026.10.0
Requires-Dist: showlib>=2026.10.0
Requires-Dist: sf-hamilton<2,>=1.87.0
Requires-Dist: hitran-api
Requires-Dist: dask>=2025.11.0
Requires-Dist: seaborn>=0.13.2
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Dynamic: license-file

# HAWCsat Simulator Package

[![Documentation Status](https://readthedocs.org/projects/hawc-simulator/badge/?version=latest)](https://usask_arg_example.readthedocs.io/en/latest/?badge=latest)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/usask-arg/hawc-simulator/main.svg)](https://results.pre-commit.ci/latest/github/usask-arg/usask_arg_example/main)

## Installation
The package can be installed through

`pip install hawcsimulator`

## Usage
Documentation can be found at  https://hawc-simulator.readthedocs.io/

## Development
The development environment is managed with [uv](https://docs.astral.sh/uv/).  By default `uv sync`
installs `skretrieval`, `showlib`, and `ali-processing` from local clones next to this repository;
use `uv sync --no-sources` to use the released versions instead.  See the
[local setup guide](https://hawc-simulator.readthedocs.io/en/latest/developer/local_setup.html) for details.

```
uv sync                       # create .venv with hawcsimulator and the dev tools
uv run pytest                 # run the tests
uv run pre-commit run -a      # lint and format
uv run sphinx-build -b html docs/source docs/build   # build the docs
```

## License
This project is licensed under the MIT license
