PyOTC: A Python Package for Optimal Transition Coupling
PyOTC: A Python Package for Optimal Transition Coupling - Published in JOSS (2026)
Science Score: 89.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
✓DOI references
Found 2 DOI reference(s) in README and JOSS metadata -
○Academic publication links
-
✓Committers with academic emails
1 of 4 committers (25.0%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Repository
Perform optimal transition coupling in python.
Basic Info
- Host: GitHub
- Owner: pyotc
- License: mit
- Language: Jupyter Notebook
- Default Branch: main
- Size: 735 KB
Statistics
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 3
- Releases: 9
Metadata Files
README.md
pyotc
A python implementation of optimal transport coupling algorithms.
Documentation
Find sphinx documentation here.
Installation
We expect pyotc to be pip-installable across all platforms.
1. Install from pypi (Recommended)
bash
pip install pyotc
- Note: pyotc requires Python 3.10 or above.
2. Install from github
bash
pip install git+https://github.com/pyotc/pyotc.git
3. Install for Development
We test in venvs provided by uv via nox. It's helpful, but not strictly necessary to do the same.
bash
git clone https://github.com/pyotc/pyotc.git
cd pyotc
pip install -e .
uv workflow
Install the uv tool. Then
bash
git clone https://github.com/pyotc/pyotc.git
cd pyotc
uv sync
uv pip install -e .
To verify your installation, run
bash
uv run pytest
Run Tests
With a uv setup one can simply
bash
uv run pytest
Otherwise, in pip installed context with deps met, pytest should behave as expected.
Contributing
Guidelines for contribution to pyotc are provided in CONTRIBUTING.md.
Changelog
A summary of changes and guide to versioning are recoreded in CHANGELOG.md.
Citing this Repository
If you wish to cite our work, please use the following BibTeX code:
bibtex
@article{yi2025alignment,
title={Alignment and comparison of directed networks via transition couplings of random walks},
author={Yi, Bongsoo and O'Connor, Kevin and McGoff, Kevin and Nobel, Andrew B},
journal={Journal of the Royal Statistical Society Series B: Statistical Methodology},
pages={qkae085},
year={2024},
doi = {10.1093/jrsssb/qkae085}
}
Owner
- Name: pyotc
- Login: pyotc
- Kind: organization
- Repositories: 1
- Profile: https://github.com/pyotc
JOSS Publication
PyOTC: A Python Package for Optimal Transition Coupling
Authors
Department of Statistics and Operations Research, University of North Carolina at Chapel Hill, Chapel Hill, NC, United States of America
Department of Mathematics and Statistics, Boston University, Boston, MA, United States of America
Applied Research Associates, Raleigh, NC, United States of America
Editor
Wentao Ye
Tags
Optimal Transport ProbabilityGitHub Events
Total
- Release event: 2
- Delete event: 19
- Pull request event: 22
- Issues event: 18
- Watch event: 1
- Issue comment event: 13
- Public event: 1
- Push event: 63
- Pull request review event: 3
- Create event: 22
Last Year
- Release event: 2
- Delete event: 19
- Pull request event: 22
- Issues event: 18
- Watch event: 1
- Issue comment event: 13
- Public event: 1
- Push event: 63
- Pull request review event: 3
- Create event: 22
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Jay Hineman | j****n | 32 |
| Bongsoo Yi | a****i@n****m | 15 |
| icyyyyy730 | p****g@b****u | 7 |
| Jay Hineman | j****n@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 3 days ago
All Time
- Total issues: 8
- Total pull requests: 5
- Average time to close issues: about 2 months
- Average time to close pull requests: 1 day
- Total issue authors: 1
- Total pull request authors: 2
- Average comments per issue: 1.5
- Average comments per pull request: 0.8
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 7
- Pull requests: 5
- Average time to close issues: about 1 month
- Average time to close pull requests: 1 day
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 0.86
- Average comments per pull request: 0.8
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jhineman (8)
Pull Request Authors
- jhineman (4)
- icyyyyy730 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 92 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 4
- Total maintainers: 2
pypi.org: pyotc
Perform optimal transition coupling (OTC) in python.
- Documentation: https://pyotc.readthedocs.io/
- License: MIT license
-
Latest release: 0.3.3
published 3 months ago
Rankings
Dependencies
- actions/checkout v4 composite
- actions/setup-python v5 composite
- astral-sh/setup-uv v5 composite
- matplotlib >=3.10.0
- networkx >=3.4.2
- numpy >=2.2.1
- pot >=0.9.5
- argcomplete 3.5.3
- colorama 0.4.6
- colorlog 6.9.0
- contourpy 1.3.1
- coverage 7.6.10
- cycler 0.12.1
- distlib 0.3.9
- exceptiongroup 1.2.2
- filelock 3.16.1
- fonttools 4.55.3
- iniconfig 2.0.0
- kiwisolver 1.4.8
- matplotlib 3.10.0
- networkx 3.4.2
- nox 2024.10.9
- numpy 2.2.1
- packaging 24.2
- pillow 11.0.0
- platformdirs 4.3.6
- pluggy 1.5.0
- pot 0.9.5
- py-cpuinfo 9.0.0
- pyotc 0.1.0
- pyparsing 3.2.1
- pytest 8.3.4
- pytest-benchmark 5.1.0
- pytest-cov 6.0.0
- python-dateutil 2.9.0.post0
- ruff 0.8.4
- scipy 1.14.1
- six 1.17.0
- tomli 2.2.1
- virtualenv 20.28.0
- actions/checkout v4 composite
- actions/configure-pages v5 composite
- actions/deploy-pages v4 composite
- actions/setup-python v5 composite
- actions/upload-pages-artifact v3 composite