PyChor is a small Python library for writing choreographic programs: global descriptions of distributed protocols that make party ownership, local computation, and communication explicit.
pip install pychorInstall the documentation dependencies:
python -m pip install -e ".[docs]"Preview the documentation locally:
mkdocs serveValidate the static site before publishing:
mkdocs build --strictDeploy the documentation manually to GitHub Pages:
mkdocs gh-deploy --cleanConfigure GitHub Pages for the repository to publish from the gh-pages branch.
The generated site/ directory is ignored on main; mkdocs gh-deploy builds
the site and pushes it to gh-pages.
See the documentation tutorial for a minimal current example. The examples
directory contains additional protocol sketches.
This material is based upon work supported by the National Science Foundation under Grant No. 2238442. Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.