Skip to main content

Graph-Oriented Computer-Assisted Composition in Python

Project description

PyPI version Python 3.10+ License: CC BY-SA 4.0

Klotho

Klotho, from the Ancient Greek κλώθω (klṓthō), meaning "to spin." The mythological figure Clotho, one of the three Fates, takes her name from this same word.

Klotho is an open source computer-assisted composition toolkit implemented in Python. It is designed to work in tandem with external synthesis applications and as a resource for the methods and models associated with musical abstraction and computation.

Klotho adapts to multiple Python workflows, supporting traditional scripting, interactive notebook environments, and immediate computational tasks through the interpreter.


Companion Book

An interactive Jupyter Book exploring the theory, mathematics, and CAC practice behind Klotho. This is a work in progress, but will ultimately cover such topics as foundational graph structures, formal grammars, evolutionary algorithms, quantum fields, and beyond.

Readable directly in your browser with no installation required.

Read online: https://kr4g.github.io/klotho-book/


Installation

Option 1: Install from PyPI (Recommended)

pip install klotho-cac

That's it. You're ready to go.

Option 2: Install from Source

Clone the repository to get a local copy of the Klotho source code, then install in editable mode:

git clone https://github.com/kr4g/Klotho.git
cd Klotho/
pip install -e .

Editable mode (-e) means changes you make to the source are immediately reflected without reinstalling.

For contributors: To also install testing and documentation tools, run pip install -e .[dev] instead.


Integration with SuperCollider

To use Klotho with SuperCollider, see the Klotho-SC extension package: https://github.com/kr4g/Klotho-SC.git.


Documentation

📖 Online Documentation: https://klotho.readthedocs.io/

The complete documentation is available online and includes:

  • Complete API reference for all modules
  • Usage examples and tutorials
  • NumPy-style docstring documentation

🛠️ Build Documentation Locally (Optional):

For developers who want to build the documentation locally or preview changes:

pip install klotho-cac[docs]
cd docs
make dev

License

Klotho © 2023–2026 by Ryan Millett is licensed under CC BY-SA 4.0.

CC Icon BY Icon SA Icon

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

klotho_cac-10.1.0.tar.gz (494.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

klotho_cac-10.1.0-py3-none-any.whl (515.5 kB view details)

Uploaded Python 3

File details

Details for the file klotho_cac-10.1.0.tar.gz.

File metadata

  • Download URL: klotho_cac-10.1.0.tar.gz
  • Upload date:
  • Size: 494.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for klotho_cac-10.1.0.tar.gz
Algorithm Hash digest
SHA256 b267e0eaa6474b6b69b14406c5b7a39f279c2c4c79b2eff3afb2b5d2c141f31f
MD5 59f3fa67d1a8cd9dacf772d20017185e
BLAKE2b-256 cf01ad47fe95c4187088eec8b140c157d2ea344ad37148f223c87dec51d60288

See more details on using hashes here.

File details

Details for the file klotho_cac-10.1.0-py3-none-any.whl.

File metadata

  • Download URL: klotho_cac-10.1.0-py3-none-any.whl
  • Upload date:
  • Size: 515.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for klotho_cac-10.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 66c4d046b86b3e21813fdb0fb0bb8625f247f3cccc2a26497d7d077e5ef19ca2
MD5 76ac554e4c536d4bf0cab5ee61e61a2e
BLAKE2b-256 868690dcd949be60eab2c030ec630976df53e38a5b20629e8e3ee168babfd086

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page