Metadata-Version: 2.4
Name: iconspy
Version: 0.2.5
Summary: ICON Sections in PYthon
Author-email: Fraser William Goldsworth <frasergocean@gmail.com>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/eerie-project/iconspy
Project-URL: Documentation, https://eerie-project.github.io/iconspy/
Project-URL: Source, https://github.com/eerie-project/iconspy
Project-URL: Tracker, https://github.com/eerie-project/iconspy/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pip
Requires-Dist: numpy
Requires-Dist: xarray
Requires-Dist: cartopy
Requires-Dist: networkx
Requires-Dist: matplotlib
Requires-Dist: scipy
Requires-Dist: cmocean
Requires-Dist: netcdf4
Requires-Dist: requests
Requires-Dist: scikit-learn
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: nbval; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx_rtd_theme; extra == "dev"
Requires-Dist: sphinx-autodoc-typehints; extra == "dev"
Requires-Dist: sphinx-copybutton; extra == "dev"
Requires-Dist: pygments; extra == "dev"
Requires-Dist: nbsphinx; extra == "dev"
Requires-Dist: nbconvert; extra == "dev"
Requires-Dist: myst-parser; extra == "dev"
Requires-Dist: ipython; extra == "dev"
Requires-Dist: flox; extra == "dev"
Requires-Dist: numba; extra == "dev"
Requires-Dist: numbagg; extra == "dev"
Requires-Dist: bottleneck; extra == "dev"
Requires-Dist: dask-mpi; extra == "dev"
Requires-Dist: distributed; extra == "dev"
Requires-Dist: ipympl; extra == "dev"
Dynamic: license-file

[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.21904575.svg)](https://doi.org/10.5281/zenodo.21904575)
# iconspy

## ICON Sections in PYthon
[`iconspy`](https://github.com/eerie-project/iconspy) is a python package for constructing sections on the [ICON model's](https://gitlab.dkrz.de/icon/icon-model) native grid.
It offers the ability to create sections that approximate great circles, follow lines of constant latitude or longitude,
and follow contours of an arbitrary field.

The functionality builds upon that provided  by the [`pyicon`](https://gitlab.dkrz.de/m300602/pyicon) package;
however, `iconspy` offers some extra functionality —
in particular the ability to join together multiple sections and construct sections which follow contours.

Documentation is hosted [here](https://eerie-project.github.io/iconspy/) and the package code [here](https://github.com/eerie-project/iconspy).

## Citation
If you use this software in your work, please consider citing it with either an in-text citation (preferred) or in the acknowledgements. 

For the text I recommend something along the lines of
> Sections were constructed on the native ICON grid using `iconspy` (Goldsworth, 2026).

Followed by a bibliography entry of the form
> Goldsworth, F. W. (2026). eerie-project/iconspy: vX (Version X) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.21904575

If you use LaTeX you may want to use the bibtex entry:
```
@software{goldsworth2026iconspy,
  author  = {Goldsworth, Fraser William},
  title   = {{eerie-project/iconspy: vX}},
  year    = {2026},
  publisher = {Zenodo},
  version = {X},
  doi     = {10.5281/zenodo.21904575},
}
```

## Issues and feature requests
If you encounter any problems with the code please raise an issue on [github](https://github.com/eerie-project/iconspy).
If you have feature requests feel free to reach out there also.

## Acknowledgements
This software was developed as part of the EERIE project (grant agreement no 101081383) funded by the European Union.

This software contains modified code from the [`pyicon`](https://gitlab.dkrz.de/m300602/pyicon) package, namely:
  - function iconspy.core.Section._get_pyic_orientation_along_path
  - function iconspy.utils._pyicon_convert_tgrid_data

An MIT license applies to these parts of the code (see also the `LICENSE` file).
I am grateful to Nils Brüggemann for his ongoing development and maintenance of the [`pyicon`](https://gitlab.dkrz.de/m300602/pyicon) package.
