Skip to content

ales-tsurko/athenaCL

Repository files navigation

athenaCL

athenaCL screenshot

athenaCL is an algorithmic composition tool created by Christopher Ariza.

Or, as described by the author more specifically, it is a tool for:

modular poly-paradigm algorithmic music composition in a cross-platform interactive command-line environment.

Documentation

The manual is built using mdBook you will find the source code inside doc/ directory. You can read it here.

Usage

The repo includes large files tracked by git-lfs. You need it to be installed on your system. Then, after you cloned the repo:

git lfs pull

Then you can run the program using:

cargo run --release

cargo test will run not only rust tests, but python tests as well.

Bundle an app on macOS

Currently, bundling app packages configured on macOS only. To bundle a package:

./bundle-mac.sh

After that the .app package should be located at target/release/bundle/osx/athenaCL.app.

About This Fork

Initially this repo was forked to update the code to python3. But then I considered to build a GUI version of athenaCL. Today the code is adapted for GUI needs:

  • it's modified to be easily embeddable into binary (using RustPython and freezing);
  • some features related to CLI are removed, to make it work better with RustPython;
  • while the CLI version might still work, it's not supported, so expect bugs.

If you're interested in the original (CLI) version, check out the pregui tag.