Metadata-Version: 2.4
Name: oscillon
Version: 0.1.0a2
Summary: A Python machine learning implementation for gCTLN models.
Project-URL: Homepage, https://github.com/lburtle/oscillon
Project-URL: Bug Tracker, https://github.com/lburtle/oscillon/issues
Project-URL: Discussions, https://github.com/lburtle/oscillon/discussions
Project-URL: Changelog, https://github.com/lburtle/oscillon/releases
Author-email: Landon Burtle <landonburtle10@gmail.com>
License-Expression: BSD-3-Clause
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: jax
Requires-Dist: jaxlib
Requires-Dist: matplotlib
Requires-Dist: networkx
Requires-Dist: numpy
Requires-Dist: torch
Provides-Extra: cuda12
Requires-Dist: jax[cuda12]; extra == 'cuda12'
Provides-Extra: cuda12-local
Requires-Dist: jax[cuda12-local]; extra == 'cuda12-local'
Provides-Extra: cuda13-local
Requires-Dist: jax[cuda13-local]; extra == 'cuda13-local'
Description-Content-Type: text/markdown

# Oscillon
<img width="50%" alt="Image" src="https://github.com/user-attachments/assets/2e054a26-214b-4d45-809c-478627386d51" />

[![Actions Status][actions-badge]][actions-link]
[![Documentation Status][rtd-badge]][rtd-link]

[![PyPI version][pypi-version]][pypi-link]
[![Conda-Forge][conda-badge]][conda-link]
[![PyPI platforms][pypi-platforms]][pypi-link]

[![GitHub Discussion][github-discussions-badge]][github-discussions-link]

[![Coverage][coverage-badge]][coverage-link]

<!-- SPHINX-START -->

<!-- prettier-ignore-start -->
[actions-badge]:            https://github.com/lburtle/oscillon/actions/workflows/ci.yml/badge.svg
[actions-link]:             https://github.com/lburtle/oscillon/actions
[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/oscillon
[conda-link]:               https://github.com/conda-forge/oscillon-feedstock
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
[github-discussions-link]:  https://github.com/lburtle/oscillon/discussions
[pypi-link]:                https://pypi.org/project/oscillon/
[pypi-platforms]:           https://img.shields.io/pypi/pyversions/oscillon
[pypi-version]:             https://img.shields.io/pypi/v/oscillon
[rtd-badge]:                https://readthedocs.org/projects/oscillon/badge/?version=latest
[rtd-link]:                 https://oscillon.readthedocs.io/en/latest/?badge=latest
[coverage-badge]:           https://codecov.io/github/lburtle/oscillon/branch/main/graph/badge.svg
[coverage-link]:            https://codecov.io/github/lburtle/oscillon

<!-- prettier-ignore-end -->

This package is intended to be a machine learning implementation and tool for general Combinatorial Threshold Linear Networks (gCTLNs). The name is inspired by the oscillating and dynamic behavior of oscillons, similar to the type of behavior exhibity in CTLNs. This package/repository is currently under development. Thank you for your patience.
