Pylanetary and its dependencies are pip installable (tested in a blank Conda environment):
conda create -n pylanetary-tester python=3.9 source activate pylanetary-tester pip install pylanetary
Some of the ring modeling modules rely on a pre-release (at time of writing) version of astroquery, so you may need to download that package via git as shown in requirements.txt
To install the development branch, run:
conda create -n pylanetary-tester python=3.9 source activate pylanetary-tester git clone -b active-dev https://github.com/emolter/pylanetary.git cd pylanetary pip install -r requirements.txt python setup.py install
The idea behind pylanetary is to bring solar system science tools into the open-source Python 3 / Astropy ecosystem. We, and many of our colleagues, rely heavily on useful code snippets passed down from other solar system scientists. But these pieces of code are untested, in multiple languages (IDL, Python 2, etc.), closed-source, and have many untracked dependencies. We want to fix that.
At present, we are working on two main packages: 1. navigation: Tools to make and use ellipsoidal models of planets/large moons. This subpackage projects planet models into arbitrary observing geometries and pixel scales, compares those models with observational data, assigns latitudes, longitudes, and emission angles to observational data, and projects images onto latitude-longitude grids. 2. rings: Tools to model planetary ring systems. This subpackage projects ring models into arbitrary observing geometries and pixel scales, compares those models with observational data, and makes radial and azimuthal profiles of observed rings.
The eventual goal is to become Astropy-affiliated, but that is a long way off. At present, this repository is just a skeleton. We would love your help developing it! See Contributing.
This project is Copyright (c) Ned Molter & Chris Moeckel and licensed under the terms of the BSD 3-Clause license. This package is based upon the Astropy package template which is licensed under the BSD 3-clause license. See the licenses folder for more information.
We love contributions! pylanetary is open source,
built on open source, and we'd love to have you hang out in our community.
Please read CONTRIBUTING.rst before you start.
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 pylanetary based on its use in the README file for the MetPy project.
