Metadata-Version: 2.4
Name: damoco
Version: 0.1.4
Summary: Python port of DAMOCO MATLAB functions.
Author: Çağdaş Topçu
Maintainer: Çağdaş Topçu
License-Expression: MIT
Project-URL: Homepage, https://github.com/cagdastopcu/damoco
Project-URL: Repository, https://github.com/cagdastopcu/damoco
Project-URL: Issues, https://github.com/cagdastopcu/damoco/issues
Project-URL: Source-MATLAB, http://www.stat.physik.uni-potsdam.de/%7Emros/damoco2.html
Keywords: oscillator,phase,coupling,damoco,dynamics,synchronization
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
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: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.24
Requires-Dist: scipy>=1.10
Requires-Dist: matplotlib>=3.7
Provides-Extra: dev
Requires-Dist: pytest>=7.4; extra == "dev"
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: twine>=5.0; extra == "dev"
Dynamic: license-file

# damoco

`damoco` is a Python port of the DAMOCO MATLAB toolbox functions in this repository.

DAMOCO: Data Analysis with Models Of Coupled Oscillators

## Reference MATLAB Toolbox

- Official DAMOCO MATLAB page: http://www.stat.physik.uni-potsdam.de/%7Emros/damoco2.html

## Attribution

- MATLAB toolbox creators: Björn Kralemann, Michael Rosenblum, Arkady Pikovsky (DAMOCO toolbox), and collaborators.
- Ported to Python by: Çağdaş Topçu.

## Scope

- Function names are preserved (`co_fcplfct2`, `co_tricplfan`, `co_hilbproto`, etc.).
- Default arguments and conventions were ported to match MATLAB behavior.
- Plotting utilities were reimplemented with Matplotlib.

## Install

Published package:

```bash
pip install damoco
```

Directly from GitHub:

```bash
pip install git+https://github.com/cagdastopcu/damoco.git
```

Local editable development install:

```bash
pip install -e .[dev]
```

## Test

```bash
pytest -q
```

## Documentation

- Full user/developer docs: [docs/DOCUMENTATION.md](docs/DOCUMENTATION.md)
- Mathematical theory: [docs/THEORY.md](docs/THEORY.md)
- Validation guide: [docs/VALIDATION.md](docs/VALIDATION.md)
- PyPI release guide: [docs/PUBLISH.md](docs/PUBLISH.md)
