Metadata-Version: 2.4
Name: spice-segmenter
Version: 0.0.6
Summary: Spice-based segmenter, wrapping event finding routines within spice toolkit.
Project-URL: Documentation, https://luca-penasa.github.io/spice-segmenter
Project-URL: Homepage, https://luca-penasa.github.io/spice-segmenter
Project-URL: Repository, https://github.com/luca-penasa/spice-segmenter
Author-email: Luca Penasa <luca.penasa@gmail.com>
License: MIT
License-File: LICENCE
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: anytree>=2.8.0
Requires-Dist: attrs>20.0.0
Requires-Dist: cattrs>=23
Requires-Dist: datetimerange>=2.1.0
Requires-Dist: importlib-metadata>=8.5.0
Requires-Dist: loguru>=0.7.2
Requires-Dist: pandas>=2.0.1
Requires-Dist: pint>=0.20
Requires-Dist: planetary-coverage>=1.0.0
Requires-Dist: ptr-editor>=0.4.0
Requires-Dist: quick-spice-manager>=0.0.1
Requires-Dist: spiceypy>=5.1.1
Requires-Dist: tqdm>=4.65.0
Provides-Extra: dev
Requires-Dist: bump-my-version>=0.27.0; extra == 'dev'
Requires-Dist: ipykernel>=6.29.5; extra == 'dev'
Requires-Dist: mkdocs-jupyter>=0.25.1; extra == 'dev'
Requires-Dist: mkdocs-material; extra == 'dev'
Requires-Dist: mkdocs-with-pdf>=0.9.3; extra == 'dev'
Requires-Dist: mkdocstrings[python]>=0.23; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: nbmake>=1.4.6; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pymdown-extensions; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-github-actions-annotate-failures; extra == 'dev'
Requires-Dist: pytest-sugar>=1.0.0; extra == 'dev'
Requires-Dist: python-kacl; extra == 'dev'
Requires-Dist: ruff>=0.2.0; extra == 'dev'
Requires-Dist: rust-just>=1.36.0; extra == 'dev'
Description-Content-Type: text/markdown

# Spice Segmenter

[![PyPI](https://img.shields.io/pypi/v/spice-segmenter?style=flat-square)](https://pypi.python.org/pypi/spice-segmenter/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/spice-segmenter?style=flat-square)](https://pypi.python.org/pypi/spice-segmenter/)
[![PyPI - License](https://img.shields.io/pypi/l/spice-segmenter?style=flat-square)](https://pypi.python.org/pypi/spice-segmenter/)
[![Coookiecutter - Wolt](https://img.shields.io/badge/cookiecutter-Wolt-00c2e8?style=flat-square&logo=cookiecutter&logoColor=D4AA00&link=https://github.com/woltapp/wolt-python-package-cookiecutter)](https://github.com/woltapp/wolt-python-package-cookiecutter)


---

**Documentation**: [https://luca-penasa.github.io/spice-segmenter](https://luca-penasa.github.io/spice-segmenter)

**Source Code**: [https://github.com/luca-penasa/spice-segmenter](https://github.com/luca-penasa/spice-segmenter)

**PyPI**: [https://pypi.org/project/spice-segmenter/](https://pypi.org/project/spice-segmenter/)

---



## Installation

```sh
pip install spice-segmenter
```

## Development

* Clone this repository
* Requirements:
  * [uv](https://docs.astral.sh/uv/)
  * Python 3.10+
* Create a virtual environment and install the dependencies

```sh
uv sync --all-extras
```

* Activate the virtual environment

```sh
source .venv/bin/activate
```

(or `.venv\Scripts\activate` on Windows)

### Testing

```sh
pytest
```

#### Regression testing

The `tests/regression/` suite locks down numerical results for both property
evaluation and constraint solving against a fixed set of SPICE kernels.  Each
test calls `compute_all` or solves a constraint, then compares the output
against a YAML baseline stored in `tests/regression/baselines/`.

**Normal CI run** — compare against stored baselines:

```sh
pytest tests/regression/
```

**After a kernel delivery / planned geometry change** — regenerate all baselines,
review the diff, then commit:

```sh
pytest tests/regression/ --update-regression
git diff tests/regression/baselines/   # review what changed
git add tests/regression/baselines/
git commit -m "chore: update regression baselines for kernel v<new>"
```

**Regenerate a single case** (useful when adding a new property or constraint):

```sh
pytest tests/regression/ --update-regression -k "ganymede_start"
```

Tolerances applied during comparison:

| Quantity | Tolerance |
|---|---|
| Scalar / vector numeric values | 1 ppm relative |
| Solver total coverage duration | 0.01 % relative |
| Individual interval start / end | 60 s absolute |

Both `n_intervals` and each interval boundary are stored, so a code change that
shifts event times or changes the number of detected intervals will always
produce a clear failure message.

### Documentation

The documentation is automatically generated from the content of the [docs directory](https://github.com/luca-penasa/spice-segmenter/tree/master/docs) and from the docstrings
 of the public signatures of the source code. The documentation is updated and published as a [Github Pages page](https://pages.github.com/) automatically as part each release.



### Releasing

#### Manual release

Releases are done with the command, e.g. incrementing patch:

```bash
just bump patch
# also push, of course:
git push origin main --tags
```

this will update the changelog, commit it, and make a corresponding tag.

as the CI is not yet configured for publish on pypi it can be done by hand:

```bash
uv build
twine upload dist/*
```
#### Automatic release - to be fixed


Trigger the [Draft release workflow](https://github.com/luca-penasa/spice-segmenter/actions/workflows/draft_release.yml)
(press _Run workflow_). This will update the changelog & version and create a GitHub release which is in _Draft_ state.

Find the draft release from the
[GitHub releases](https://github.com/luca-penasa/spice-segmenter/releases) and publish it. When
 a release is published, it'll trigger [release](https://github.com/luca-penasa/spice-segmenter/blob/master/.github/workflows/release.yml) workflow which creates PyPI
 release and deploys updated documentation.

### Updating with copier

To update the skeleton of the project using copier:
```sh
 pipx run copier update --defaults
```

### Pre-commit

Pre-commit hooks run all the auto-formatting (`ruff format`), linters (e.g. `ruff` and `mypy`), and other quality
 checks to make sure the changeset is in good shape before a commit/push happens.

You can install the hooks with (runs for each commit):

```sh
pre-commit install
```

Or if you want them to run only for each push:

```sh
pre-commit install -t pre-push
```

Or if you want e.g. want to run all checks manually for all files:

```sh
pre-commit run --all-files
```

### Running tests

```sh
uv run pytest
```

---

This project was generated using [a fork](https://github.com/luca-penasa/wolt-python-package-cookiecutter) of the [wolt-python-package-cookiecutter](https://github.com/woltapp/wolt-python-package-cookiecutter) template.
