Home

Celeritas

Celeritas is a symbolic-music engine for .NET — chord, key, mode, progression and modulation analysis, harmonization, voice leading, orchestration, ornamentation, figured bass, MIDI and MusicXML — with Python bindings.

This wiki is a signpost. The documentation is generated from the sources on every push to main and lives in one place, so that it cannot drift from the library:

📖 Documentation site — sheinv78.github.io/Celeritas

I want to…	Go to
Install the package and run a first analysis	Getting started
See what the library does, in ten minutes	10-minute tour
Understand the time model, NoteBuffer, SIMD dispatch, enharmonic spelling	Concepts
Know why a confident key detection reads 0.2, not 0.9	Reading confidence values
Copy a recipe for a task	Cookbook
Look up a type or member	API reference
Move code from 0.9.x to 0.10	Upgrading to 0.10
Read or write MusicXML	MusicXML guide
Use the engine from Python	Python quickstart · bindings README

In the repository

• README — what Celeritas is and is not, features, performance, quick start
• Examples — twelve runnable programs; CI runs each and checks it prints what it documents
• CHANGELOG — every behaviour change, release by release
• Architecture decision records
• Contributing · Roadmap · License (BSL 1.1)
• Issues — bugs and feature requests

Why the documentation is not here

Wiki pages are edited by hand and checked by nothing. The pages on the site are built from the XML documentation and the Markdown in docs/; CI compiles every C# block in them against the library and runs every example against its documented output, so a page that describes a version of the library that no longer exists fails the build instead of misleading a reader.