๐ exoatlas!#
Welcome! exoatlas is a Python package for interacting with basic properties of exoplanets and Solar System planets. It provides a friendly way to download useful data from online archives like the NASA Exoplanet Archive and JPL Solar System Dynamics, easy access to planet properties, and some pre-packaged visualizations for summarizing and comparing populations of planets.
๐ฆ How to Install exoatlas#
For most users, simply installing via
pip install exoatlas
should do the trick. If you want more detail, either because running that command seems scary or because you want to do something fancier, then please check out the installation instructions.
๐ How to Use this Documentation#
Let's be honest, you're probably going to skip over most of the documentation to look for your own very specific use. Good for you, that sounds like the right way to go!
The documenation is targeted at someone with basic knowledge in astronomy, planetary science, and Python. Each page is fairly self-contained, so feel free to start wherever you like. Here's a little map help guide your search more efficiently.
| If you're here because you want to... | ...then try jumping to: |
|---|---|
get a quick sense of exoatlas |
Quickstart |
learn how exoatlas defines populations |
Populations |
retrieve planet properties with exoatlas |
Creating |
do calculations and define subsets in exoatlas |
Filtering |
paint pretty population plots with exoatlas |
Visualizing |
use exoatlas to estimate signal-to-noise ratios |
Observing |
plan telescope observations of exoatlas planets |
Planning |
understand how exoatlas propagates uncertainties |
Uncertainties |
use exoatlas's BTWM26 cosmic shoreline calculator |
Shoreline |
dive into the nitty gritty of exoatlas definitions |
API Reference |
๐๏ธ How to Cite exoatlas#
A manuscript is currently under review at JOSS (as of late spring 2026). Once that is complete, we will link to the SciEx entry where you can access bibliographic data for the code/paper in multiple formats. In the meantime, this arxiv posting is a good reference.
๐ How to Get Help#
If you run into trouble with exoatlas or are curious about a new feature, and you can't obviously find a solution here in the documentation, please consider submitting an Issue on GitHub. If you're wondering about something, someone else might be too; be kind and help us all out by asking your question!