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-7.2.0.tar.gz (492.3 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-7.2.0-py3-none-any.whl (513.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for klotho_cac-7.2.0.tar.gz
Algorithm Hash digest
SHA256 5386194da7c41707231ba3146282d7c41e12eaf2d14ad738a1c7e7e7dd124f01
MD5 9a12970caab002b143bf5d3aff045660
BLAKE2b-256 a1bd70f62ebefb65ee9818fe8ea76611e382e5de02aca9d6d2ace774b865a6bb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: klotho_cac-7.2.0-py3-none-any.whl
  • Upload date:
  • Size: 513.6 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-7.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9befb8ac4fc9f3d2957bc64cb5b07725f141e1a1e5c375c1d38df1fe8b8e8952
MD5 0ce633361cb20d77a3cbea6a4bcd8592
BLAKE2b-256 88f76e52e7235b5ca1a92f6af9e13a457d099c3a2d12b96ee31bc98e6eca8e79

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