/PlasmaPy-NEI

Non-equilibrium ionization modeling of plasma with Python

Primary LanguagePythonOtherNOASSERTION

Non-equilibrium ionization modeling with Python

GitHub Actions — CI codecov GitHub Actions — Style linters Documentation Status

Matrix plasmapy astropy

PlasmaPy-NEI is being developed into an affiliated package of PlasmaPy designed to perform non-equilibrium ionization modeling of plasma. Use cases include plasma in the solar wind and during coronal mass ejections. Please read more on the online documentation.

License

This project is Copyright (c) PlasmaPy-NEI Developers and licensed under the terms of the BSD+Patent license. Additional licenses are found in the licenses folder.

Acknowledgements

Development on PlasmaPy-NEI has been supported by NASA, NSF, and the Smithsonian Institution.

Contributing

We love contributions! PlasmaPy-NEI is open source, built on open source, and we'd love to have you 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 PlasmaPy-NEI based on its use in the README file for the MetPy project.