Metadata-Version: 2.1
Name: asilib
Version: 0.24.1
Summary: An open source package providing data access and analysis tools for the world's all-sky imager (ASI) data.
Author-email: Mykhaylo Shumko <msshumko@gmail.com>
Project-URL: Homepage, https://aurora-asi-lib.readthedocs.io/
Project-URL: Documentation, https://aurora-asi-lib.readthedocs.io/
Project-URL: Source, https://github.com/mshumko/asilib
Project-URL: Issues, https://github.com/mshumko/asilib/issues
Project-URL: Changelog, https://github.com/mshumko/asilib/blob/main/CHANGELOG.md
Keywords: aurora,all sky imager,REGO,THEMIS,TREx
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
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
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: wheel
Requires-Dist: beautifulsoup4
Requires-Dist: requests
Requires-Dist: numpy<2.0
Requires-Dist: scipy>=1.10.0
Requires-Dist: pandas
Requires-Dist: matplotlib<4.0,>=3.7
Requires-Dist: ffmpeg-python
Requires-Dist: pymap3d
Requires-Dist: aacgmv2
Requires-Dist: pyshp>=2.3
Requires-Dist: rego-imager-readfile<2.0,>=1.2.0
Requires-Dist: themis-imager-readfile<2.0,>=1.2.1
Requires-Dist: trex-imager-readfile<2.0,>=1.5.1
Requires-Dist: opencv-python<5.0,>=4.8.0

![Test python package](https://github.com/mshumko/asilib/workflows/Test%20python%20package/badge.svg) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4746447.svg)](https://doi.org/10.5281/zenodo.4746446)

# asilib
asilib is an open source package providing data access and analysis tools for the world's all-sky imager (ASI) data.

> [!NOTE]  
> The asilib code on PyPI moved from [aurora-asi-lib](https://pypi.org/project/aurora-asi-lib/) to [asilib](https://pypi.org/project/asilib/). To update to version >=0.22.0, run
> 1. `python3 -m pip uninstall aurora-asi-lib` and
> 2. `python3 -m pip install asilib`.

The purpose of this project is to combine data from numerous observational ASI arrays into a single unified framework and is thus not associated with the development and operations of all sky cameras, or the curation of ASI datasets. All data is publicly available and is provided as-is. Please give appropriate credit and coordinate with instrument teams with regards to data issues and/or interpretation. See the [Acknowledgements](https://aurora-asi-lib.readthedocs.io/en/latest/index.html#acknowledgements) section for more information. Currently the supported camera systems (arrays) are: 
* [Red-line Emission Geospace Observatory (REGO)](https://aurora-asi-lib.readthedocs.io/en/latest/imager_api.html#rego-asi)
* [Time History of Events and Macroscale Interactions during Substorms (THEMIS)](https://aurora-asi-lib.readthedocs.io/en/latest/imager_api.html#module-asilib.asi.themis)
* [Transition Region Explorer (TREx)](https://aurora-asi-lib.readthedocs.io/en/latest/imager_api.html#module-asilib.asi.trex)

[Documentation](https://aurora-asi-lib.readthedocs.io/) | [Code on GitHub](https://github.com/mshumko/asilib) | [PyPI archive](https://pypi.org/project/asilib/) | [Zenodo archive](https://doi.org/10.5281/zenodo.4746446)

![A geographic map showing the spatial coverage (field of view rings) of all imagers supported by asilib.](https://github.com/mshumko/asilib/blob/main/docs/_static/global_coverage.png?raw=true)

![An asilib collage showing fisheye images, mapped images, and a keogram from the THEMIS and REGO imagers at RANK.](https://github.com/mshumko/asilib/blob/main/docs/_static/collage.png?raw=true)

[And you can animate images & conjunctions!](https://aurora-asi-lib.readthedocs.io/en/latest/basics_tutorial.html#Satellite-conjunction)

See more examples in the [online documentation](https://aurora-asi-lib.readthedocs.io/en/latest/examples.html) 

Your contributions and ideas are always welcome. The easiest way is to submit [Issues](https://github.com/mshumko/asilib/issues) or [Pull Requests](https://github.com/mshumko/asilib/pulls).

# Acknowledgments
Are in the [Acknowledgements](https://aurora-asi-lib.readthedocs.io/en/latest/index.html#acknowledgements) section of the online documentation.
