corona-lab 0.1.0

Tool for created synthetic observations from a model stellar magnetic corona.

⚠️ This is code is very very much under active development and in an alpha state.

Implements a PFSS model with stellar prominences.

Developer Documentation

Installation

$ git clone https://github.com/St-andrews-cool-stars/model_corona.git
$ cd model_corona
$ pip install .

For active developement intall in develop mode

$ pip install -e .

Testing

Testing is run with tox (pip install tox). Tests can be found in corona_lab/tests/.

$ tox -e test

Tests can also be run directly with pytest:

$ pip install -e .[test]
$ pytest

You can specify a single directory or file to test as:

$ pytest corona_lab/tests/test_radio.py

Codestyle can be checked with:

$ tox -e codestyle

Documentation

Documentation files are found in docs/.

We build the documentation with tox (pip install tox):

$ tox -e build-docs

You can also build the documentation with Sphinx directly using:

$ pip install -e .[docs]
$ cd docs
$ make html

The built docs will be in docs/_build/html/, to view them go to file:///path/to/corona_lab/repo/docs/_build/html/index.html in the browser of your choice.

License

This project is Copyright (c) St Andrews Cool Stars Group 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! model_corona 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 model_corona based on its use in the README file for the MetPy project.