Metadata-Version: 2.4
Name: arc-actris
Version: 1.1.0
Summary: Algorithm for Rayleigh and Raman Calculations for atmospheric lidar applications.
Author: Ioannis Binietoglou, Michael Haimerl, Volker Freudenthaler, Mariana Adam, Giuseppe D'Amico, Benedikt Gast, Moritz Haarig, Ulla Wandinger
Author-email: Nikolaos Siomos <nikolaos.siomos@lmu.de>
Maintainer-email: Nikolaos Siomos <nikolaos.siomos@lmu.de>
License: AGPL-3.0-only
Project-URL: Homepage, https://github.com/nikolaos-siomos/arc-actris
Project-URL: Repository, https://github.com/nikolaos-siomos/arc-actris
Project-URL: Documentation, https://nikolaos-siomos.github.io/arc-actris/
Project-URL: Issues, https://github.com/nikolaos-siomos/arc-actris/issues
Keywords: lidar,rayleigh,raman,atmospheric-science,actris,molecular-scattering
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: <3.14,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.24.2
Requires-Dist: scipy>=1.10.1
Requires-Dist: matplotlib>=3.7.1
Requires-Dist: pyparsing<3.3,>=3.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: twine>=5.0; extra == "dev"
Requires-Dist: mkdocs>=1.6; extra == "dev"
Requires-Dist: mkdocs-material>=9.5; extra == "dev"
Dynamic: license-file

# ARC-ACTRIS
[![Tests](https://github.com/nikolaos-siomos/arc-actris/actions/workflows/tests.yml/badge.svg)](https://github.com/nikolaos-siomos/arc-actris/actions/workflows/tests.yml)
[![Docs](https://github.com/nikolaos-siomos/arc-actris/actions/workflows/docs.yml/badge.svg)](https://github.com/nikolaos-siomos/arc-actris/actions/workflows/docs.yml)
[![Python](https://img.shields.io/badge/python-3.9--3.13-blue.svg)](https://www.python.org/)
[![License: AGPL v3](https://img.shields.io/badge/license-AGPL--3.0-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)

ARC-ACTRIS is a Python package for molecular Rayleigh and Raman scattering calculations in atmospheric lidar applications.

## Links
- Documentation: https://nikolaos-siomos.github.io/arc-actris/
- Source code: https://github.com/nikolaos-siomos/arc-actris
- Issue tracker: https://github.com/nikolaos-siomos/arc-actris/issues

## Installation

From PyPI:

```bash
pip install arc-actris
```

Development installation with `venv`:

```bash
git clone https://github.com/nikolaos-siomos/arc-actris.git
cd arc
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
pytest
```

Development installation with Conda:

```bash
git clone https://github.com/nikolaos-siomos/arc-actris.git
cd arc
conda create -n arc-actris python=3.11
conda activate arc-actris
pip install -e ".[dev]"
pytest
```

## Basic usage

```python
from arc_actris import arc

rrs = arc(incident_wavelength=355)
cross_section_355 = rrs.cross_section(cross_section_type="full")

print(cross_section_355)
```

Backscattering and molecular linear depolarization ratio, MLDR:

```python
from arc_actris import arc

rrb = arc(incident_wavelength=355, backscattering=True)

print(rrb.cross_section(cross_section_type="full"))
print(rrb.mldr(mldr_type="full"))
```

## Documentation

Full documentation is available at:

https://nikolaos-siomos.github.io/arc-actris/

Alternatively, it can also be built with MkDocs.

Install the development dependencies first:

```bash
pip install -e ".[dev]"
```

Serve the documentation locally:

```bash
mkdocs serve
```

Build the static documentation site:

```bash
mkdocs build
```

## License

ARC-ACTRIS is distributed under the GNU Affero General Public License v3.0. See [LICENSE](LICENSE).
