Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 2.58 KB

README.rst

File metadata and controls

52 lines (40 loc) · 2.58 KB

STARDIS Stellar Radiative transfer

Welcome to STARDIS! STARDIS is an LTE radiative transfer Python package that utilizes the TARDIS infrastructure to generate synthetic stellar spectra. For more information about STARDIS, including a quickstart notebook, physics walkthrough and installation instructions, go to our documentation page. Or, try running the quickstart notebook yourself!

To learn more about TARDIS, including documentation and collaborator information, go here.

License

This project is Copyright (c) TARDIS Collaboration and licensed under the terms of the BSD 3-Clause license. This package is based upon the Openastronomy packaging guide which is licensed under the BSD 3-clause licence. See the licenses folder for more information.

Contributing

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