resokit 1.0.1__tar.gz

resokit-1.0.1/.github/workflows/CI.yml

@@ -0,0 +1,13 @@
+# ==============================================================
+# CI with GitHub Actions
+# ==============================================================
+
+name: ResoKit CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  testing:
+    uses: Gianuzzi/ResoKit/.github/workflows/tests.yml@main

resokit-1.0.1/.github/workflows/tests.yml

@@ -0,0 +1,55 @@
+# ==============================================================
+# CI with GitHub Actions
+# ==============================================================
+
+name: Testing
+
+on:
+  workflow_call:
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      # continue even if an enviroment fails
+      fail-fast: false
+
+      matrix: 
+        python-version: ['3.10']
+        tox_env:
+          - style
+          - docstyle
+          - check-manifest
+          - coverage
+          - make-docs
+
+        # check version by version
+        include:
+          - py_version: 3.10
+            tox_env: python3.10
+          - py_version: 3.11
+            tox_env: python3.11
+          - py_version: 3.12
+            tox_env: python3.12
+
+    steps:
+      - uses: actions/checkout@main
+
+      # Necessary
+      - name: Install pandoc
+        if: ${{ matrix.tox_env == 'make-docs'}}
+        run: sudo apt-get install pandoc
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      
+      - name: Install tox
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install tox
+        
+      - name: tox -e ${{ matrix.tox_env }}
+        run: tox -re ${{ matrix.tox_env }}

resokit-1.0.1/.gitignore

@@ -0,0 +1,119 @@
+.vscode/
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+tests/__pycache__/
+# C extensions
+*.so
+
+# autogenerated by setuptools_scm
+resokit/_version.py
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# Ignore Sphinx build output
+docs/build/
+
+# Ignore LaTeX and PDF build artifacts
+docs/source/tutorials/*.aux
+docs/source/tutorials/*.log
+docs/source/tutorials/*.out
+docs/source/tutorials/*.pdf
+docs/source/tutorials/*.tex
+docs/source/tutorials/tutorial_files/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

resokit-1.0.1/.readthedocs.yaml

@@ -0,0 +1,28 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx: 
+  configuration: docs/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - method: pip
+    path: .
+  - requirements: docs/requirements.txt

resokit-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Emmanuel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

resokit-1.0.1/MANIFEST.in

@@ -0,0 +1,12 @@
+include LICENSE
+include README.md
+include pyproject.toml
+include *.yaml
+
+recursive-include resokit *.py
+
+# Exclusions
+exclude tox.ini
+exclude resokit/_version.py
+recursive-exclude docs *
+recursive-exclude tests *

resokit-1.0.1/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: resokit
+Version: 1.0.1
+Summary: Miscellaneous tools for the analysis of planetary systems.
+Author-email: Emmanuel Gianuzzi <egianuzzi@unc.edu.ar>, Matías Cerioni <matias.cerioni@unc.edu.ar>
+License: MIT
+Project-URL: Homepage, https://github.com/Gianuzzi/resokit
+Keywords: resokit,planetary systems,resonances,databases
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: attrs
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: pandas
+Requires-Dist: scipy
+Requires-Dist: requests
+Requires-Dist: beautifulsoup4
+Provides-Extra: query
+Requires-Dist: astropy; extra == "query"
+Provides-Extra: reb
+Requires-Dist: rebound; extra == "reb"
+Provides-Extra: all
+Requires-Dist: astropy; extra == "all"
+Requires-Dist: rebound; extra == "all"
+Dynamic: license-file
+
+# Welcome to **ResoKit**
+
+![logo](https://github.com/gianuzzi/resokit/raw/ema/docs/source/_static/resokit_logo.png)
+
+<!-- BODY -->
+
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://badge.fury.io/py/uttrs)
+[![ResoKit CI](https://github.com/Gianuzzi/ResoKit/actions/workflows/CI.yml/badge.svg)](https://github.com/Gianuzzi/ResoKit/actions/workflows/CI.yml)
+[![Documentation Status](https://readthedocs.org/projects/resokit/badge/?version=latest)](https://resokit.readthedocs.io/en/latest/?badge=latest)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://tldrlegal.com/license/mit-license)
+[![https://github.com/leliel12/diseno_sci_sfw](https://img.shields.io/badge/DiSoftCompCi-FAMAF-ffda00)](https://github.com/leliel12/diseno_sci_sfw)
+
+**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](https://exoplanetarchive.ipac.caltech.edu/) and the [Encyclopaedia of exoplanetary systems](https://exoplanet.eu/home/).
+
+## 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](https://exoplanetarchive.ipac.caltech.edu/) or the [Encyclopaedia of exoplanetary systems](https://exoplanet.eu/home/).
+
+- Exoplanetary Systems created within the context of the datasets.
+
+## Examples
+Some `notebook` format tutorials can be found at in the [tutorials](./docs/source/tutorials/) directory.
+
+More information available in the [documentation](https://resokit.readthedocs.io/en/latest/).
+
+
+## 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:
+
+```bash
+$ python -m pip install resokit
+```
+
+#### Extra dependencies
+
+If query online database features will be used with the [Encyclopaedia of exoplanetary systems](https://exoplanet.eu/home/) dataset, package [astropy](https://pypi.org/project/astropy/) is needed.
+
+You can install all extra ResoKit requirements via pip:
+
+```bash
+$ python -m pip install resokit[all]
+```
+
+### Development Install
+
+Clone this repo and then inside the local directory execute
+
+```bash
+$ git clone https://github.com/gianuzzi/resokit.git
+$ cd resokit
+$ python -m pip install -e .
+```
+
+## Authors
+- Emmanuel Gianuzzi [egianuzzi@unc.edu.ar](egianuzzi@unc.edu.ar) ([IATE-OAC-CONICET][], [FaMAF-UNC][]).
+- Matías Cerioni [matias.cerioni@unc.edu.ar](matias.cerioni@unc.edu.ar) ([IATE-OAC-CONICET][]).
+
+
+
+  [IATE-OAC-CONICET]: http://iate.oac.uncor.edu/
+  [OAC-CONICET]: https://oac.unc.edu.ar/
+  [FaMAF-UNC]: https://www.famaf.unc.edu.ar/

resokit-1.0.1/README.md

@@ -0,0 +1,81 @@
+# Welcome to **ResoKit**
+
+![logo](https://github.com/gianuzzi/resokit/raw/ema/docs/source/_static/resokit_logo.png)
+
+<!-- BODY -->
+
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://badge.fury.io/py/uttrs)
+[![ResoKit CI](https://github.com/Gianuzzi/ResoKit/actions/workflows/CI.yml/badge.svg)](https://github.com/Gianuzzi/ResoKit/actions/workflows/CI.yml)
+[![Documentation Status](https://readthedocs.org/projects/resokit/badge/?version=latest)](https://resokit.readthedocs.io/en/latest/?badge=latest)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://tldrlegal.com/license/mit-license)
+[![https://github.com/leliel12/diseno_sci_sfw](https://img.shields.io/badge/DiSoftCompCi-FAMAF-ffda00)](https://github.com/leliel12/diseno_sci_sfw)
+
+**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](https://exoplanetarchive.ipac.caltech.edu/) and the [Encyclopaedia of exoplanetary systems](https://exoplanet.eu/home/).
+
+## 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](https://exoplanetarchive.ipac.caltech.edu/) or the [Encyclopaedia of exoplanetary systems](https://exoplanet.eu/home/).
+
+- Exoplanetary Systems created within the context of the datasets.
+
+## Examples
+Some `notebook` format tutorials can be found at in the [tutorials](./docs/source/tutorials/) directory.
+
+More information available in the [documentation](https://resokit.readthedocs.io/en/latest/).
+
+
+## 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:
+
+```bash
+$ python -m pip install resokit
+```
+
+#### Extra dependencies
+
+If query online database features will be used with the [Encyclopaedia of exoplanetary systems](https://exoplanet.eu/home/) dataset, package [astropy](https://pypi.org/project/astropy/) is needed.
+
+You can install all extra ResoKit requirements via pip:
+
+```bash
+$ python -m pip install resokit[all]
+```
+
+### Development Install
+
+Clone this repo and then inside the local directory execute
+
+```bash
+$ git clone https://github.com/gianuzzi/resokit.git
+$ cd resokit
+$ python -m pip install -e .
+```
+
+## Authors
+- Emmanuel Gianuzzi [egianuzzi@unc.edu.ar](egianuzzi@unc.edu.ar) ([IATE-OAC-CONICET][], [FaMAF-UNC][]).
+- Matías Cerioni [matias.cerioni@unc.edu.ar](matias.cerioni@unc.edu.ar) ([IATE-OAC-CONICET][]).
+
+
+
+  [IATE-OAC-CONICET]: http://iate.oac.uncor.edu/
+  [OAC-CONICET]: https://oac.unc.edu.ar/
+  [FaMAF-UNC]: https://www.famaf.unc.edu.ar/

resokit-1.0.1/pyproject.toml

@@ -0,0 +1,59 @@
+[build-system]
+requires = ["setuptools>=61", "setuptools_scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "resokit"
+dynamic = ["version"]
+authors = [
+  {name = "Emmanuel Gianuzzi", email = "egianuzzi@unc.edu.ar"},
+  {name = "Matías Cerioni", email = "matias.cerioni@unc.edu.ar"}
+]
+license = {text = "MIT"}
+readme = "README.md"
+description = "Miscellaneous tools for the analysis of planetary systems."
+keywords = ["resokit", "planetary systems", "resonances", "databases"]
+classifiers = [
+  "Development Status :: 2 - Pre-Alpha",
+  "Intended Audience :: Education",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Scientific/Engineering",
+]
+urls = {Homepage = "https://github.com/Gianuzzi/resokit"}
+dependencies = [
+  "attrs",
+  "numpy",
+  "matplotlib",
+  "pandas",
+  "scipy",
+  "requests",
+  "beautifulsoup4",
+]
+
+[project.optional-dependencies]
+query = ["astropy"]
+reb = ["rebound"]
+all = ["astropy", "rebound"]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["resokit", "resokit.*"]
+namespaces = false
+
+[tool.setuptools_scm]
+write_to = "resokit/_version.py"
+version_scheme = "guess-next-dev"
+local_scheme = "no-local-version"
+
+[tool.black]
+line-length = 79
+target-version = ['py310', 'py311', 'py312', 'py313']

resokit-1.0.1/resokit/__init__.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# This file is part of the
+#   ResoKit Project (https://github.com/Gianuzzi/resokit).
+# Copyright (c) 2025, Emmanuel Gianuzzi
+# License: MIT
+#   Full Text: https://github.com/Gianuzzi/resokit/blob/master/LICENSE
+
+# This file indicates that the directory should be treated as a package.
+
+# ============================================================================
+# DOCS
+# ============================================================================
+"""ResoKit.
+
+ResoKit addresses the need for diagnosing and analyzing  mean motion
+resonances (MMR) in coplanar planetary systems.
+"""
+
+try:
+    from ._version import version as __version__
+except ImportError:
+    __version__ = "unknown"
+
+
+# =============================================================================
+# IMPORTS
+# =============================================================================
+
+from . import core  # noqa
+from . import datasets  # noqa
+from . import load  # noqa
+from . import query  # noqa
+from . import utils  # noqa
+from . import units  # noqa
+from .utils import mmr  # noqa
+from .utils import mass_radius  # noqa
+
+# Make the core classes available directly from the package.
+
+__all__ = [
+    "core",
+    "datasets",
+    "load",
+    "query",
+    "units",
+    "utils",
+    "mmr",
+    "mass_radius",
+]