Welcome to ResoKit’s documentation!
ResoKit is a toolkit package for easy exoplanetary databases access, and the analysis and diagnostics of resonances in n-body planetary systems.
Motivation
Given the vast number of exoplanetary systems surveyed, and the expectation of many more to come, we believe it is essential to have a tool capable of processing and providing valuable insights from such a large volume of observational data. Two prominent sources of this data are the NASA Exoplanet Archive and the Encyclopaedia of exoplanetary systems.
Features
The two main currently ResoKit applications involve the manipulation of data:
Exoplaneteary Datasets (including downloading, re-loading and updating) obtained from NASA Exoplanet Archive or the Encyclopaedia of exoplanetary systems.
Exoplanetary Systems created within the context of the datasets.
Examples
Some notebook format tutorials can be found at in the tutorials directory.
More information available in the documentation.
Future
The implementation of tools for analizyng standard n-body simulations output (and the Mean Movement Resonacnes involved) is still under development, but will be the next feature of ResoKit.
Stay tuned for updates!
Requirements
You need Python 3.10, or greater to run ResoKit.
Standard Installation
You could find ResoKit at PyPI. The standard installation via pip:
$ python -m pip install resokit
Extra dependencies
If query online database features will be used with the Encyclopaedia of exoplanetary systems dataset, package astropy is needed.
You can install all extra ResoKit requirements via pip:
$ python -m pip install resokit[all]
Development Install
Clone this repo and then inside the local directory execute
$ git clone https://github.com/gianuzzi/resokit.git
$ cd resokit
$ python -m pip install -e .
Contents
- User Guide
- API
- Misc