aagoodman / cosmicds Goto Github PK

The CosmicDS team, led by Principal Investigator Alyssa Goodman and Science PI Patricia Udomprasert, will facilitate connections between astronomers who want to tell the story of a discovery and inspire learners by letting them interrogate the data behind the story on their own, using easy-to-use but powerful data science and visualization techniques.

Install the latest version of the package through pip in a local python environment:

$ pip install git+https://github.com/cosmicds/cosmicds

Load a data story using the command line:

$ cosmicds hubble

To reload app.vue within Jupyter notebook using app.reload(), use "-e" flag during installation using the files in your local cosmicds directory:

$ pip install -e .

This project is Copyright (c) CosmicDS Developers and licensed under the terms of the GNU GPL v3+ 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.

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