aiapy 0.4.0

Installation

The current stable version of aiapy is available through the Python Package Index and can be installed via pip

pip install aiapy

or through the Anaconda distribution via conda-forge,

conda install -c conda-forge aiapy

These are the recommended ways to obtain and install aiapy. Alternatively, you can install the current development version directly from GitLab,

git clone https://gitlab.com/LMSAL_HUB/aia_hub/aiapy.git
cd aiapy
pip install -e .

If you’ll be developing aiapy, see the development setup guide.

Testing

If you want to run the test suite, first install the dev requirements,

pip install -e .[test,docs]

and then run

pytest --remote-data=any

If an internet connection is not available, exclude the --remote-data flag.

A valid install of IDL and SSW are required to run the tests that compare results from aiapy and SSW. If one is not available, these tests are automatically skipped.

The entire test suite can also be run using tox. For additional instructions, please see the SunPy development guide on testing.

License

This project is Copyright (c) AIA Instrument Team and licensed under the terms of the BSD 3-Clause license. This package is based upon the Astropy package template which is licensed under the BSD 3-clause licence. See the licenses folder for more information.

Citing

If you use aiapy in your scientific work, we would appreciate you citing it in your publications. The latest citation information can be found in the documentation, or obtained with aiapy.__citation__.

Contributing

We love contributions! aiapy is open source, built on open source, and we’d love to have you hang out in our community.

Imposter syndrome disclaimer: We want your help. No, really.

There may be a little voice inside your head that is telling you that you’re not ready to be an open source contributor; that your skills aren’t nearly good enough to contribute. What could you possibly offer a project like this one?

We assure you - the little voice in your head is wrong. If you can write code at all, you can contribute code to open source. Contributing to open source projects is a fantastic way to advance one’s coding skills. Writing perfect code isn’t the measure of a good developer (that would disqualify all of us!); it’s trying to create something, making mistakes, and learning from those mistakes. That’s how we all improve, and we are happy to help others learn.

Being an open source contributor doesn’t just mean writing code, either. You can help out by writing documentation, tests, or even giving feedback about the project (and yes - that includes giving feedback about the contribution process). Some of these contributions may be the most valuable to the project as a whole, because you’re coming to the project with fresh eyes, so you can see the errors and assumptions that seasoned contributors have glossed over.

Note: This disclaimer was originally written by Adrienne Lowe for a PyCon talk, and was adapted by aiapy based on its use in the README file for the MetPy project.