Metadata-Version: 2.1
Name: commensurability
Version: 0.1.0
Summary: A package for analyzing orbit commensurabilities.
Author-Email: ilikecubesnstuff <25328250+ilikecubesnstuff@users.noreply.github.com>
License: MIT
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Requires-Dist: orbit-tessellation>=0.2.0
Requires-Dist: pidgey>=0.2.1
Requires-Dist: matplotlib>=3.8.2
Requires-Dist: tqdm>=4.66.1
Requires-Dist: h5py>=3.10.0
Requires-Dist: more_itertools>=10.2.0
Description-Content-Type: text/markdown

# commensurability

[![PyPI - Version](https://img.shields.io/pypi/v/commensurability)](https://pypi.org/project/commensurability/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/commensurability)](https://pypi.org/project/commensurability/)
[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm.fming.dev)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

A Python package for performing analysis on orbit commensurabilities.
[`orbit-tessellation`](https://github.com/ilikecubesnstuff/orbit-tessellation) is used for commensurability evaluation.

This package uses [`pidgey`](https://github.com/ilikecubesnstuff/pidgey) as its orbit integration backend.

## Installation

Install this package via `pip`:

```
python -m pip install orbit-tessellation
```

## Usage

See the `examples` folder for usage cases. `examples/demo` provides a walkthrough of the features.
