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.3.0.tar.gz (501.9 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.3.0-py3-none-any.whl (525.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: klotho_cac-10.3.0.tar.gz
  • Upload date:
  • Size: 501.9 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.3.0.tar.gz
Algorithm Hash digest
SHA256 ef28037de222f471f155bbce3f47500abb0456697cfc55141527d06826e37296
MD5 b48b30d89741ab4f0922708db33d9af8
BLAKE2b-256 0960d846d72ccc513b3e1f1c97f1bc61da96249b706101bb9403f36ed4ab720a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: klotho_cac-10.3.0-py3-none-any.whl
  • Upload date:
  • Size: 525.0 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 16600c3d0c9c8909bd5bffc94d875285eb7d9a6a91cc166dff9783b9db68ceee
MD5 6587171ea006452c9c949cdd53956c93
BLAKE2b-256 55c7fdf9ca62431a4d7f1ddc02b9f33f104781b4e8b8a4e02b70de7ce791aa3d

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