Skip to content

A Python package to process and analyze data from the HERMES SPAN-Ion instrument.

License

Notifications You must be signed in to change notification settings

HERMES-SOC/hermes_spani

Repository files navigation

Overview

docs Documentation Build Status Documentation Status
build status Build Status Codestyle and linting using flake8 coverage

This is a Python package for processing and analyzing data from the Solar Probe Analyzer for Ions (SPAN-i) instrument on the Lunar Gateway. The SPAN-i ion sensor measures Interplanetary and Magnetotail ion flux as functions of direction and energy/charge from several eV/q to 20 keV/q. A time-of-flight section enables it to sort particles by their mass/charge ratio, permitting differentiation of ion species.

License

This project is Copyright (c) Jane Doe and licensed under the terms of the BSD 3-Clause "New" or "Revised" License license. This package is based upon the Openastronomy packaging guide which is licensed under the BSD 3-clause licence. See the LICENSE file for more information.

Contributing

We love contributions! hermes_spani 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 hermes_spani based on its use in the README file for the MetPy project.

Code of Conduct

When you are interacting with the HERMES-SOC community you are asked to follow our Code of Conduct.

Acknowledgements

The package template used by this package is based on the one developed by the OpenAstronomy community and the SunPy Project.

About

A Python package to process and analyze data from the HERMES SPAN-Ion instrument.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages