Dicy2 is a collection of agents and tools using machine-learning for the interactive generation of structured musical sequences. It can be integrated into musical setups ranging from the production of structured material within a compositional process to the design of autonomous agents for improvised interaction. It is available as a plugin for Ableton Live and a library for Max.
The Dicy2 Python library is a library of the Ircam Musical Representations team, designed and developed by Jérôme Nika and Joakim Borg (Python generative engine / Gig RepMus API) in the framework of the projects ANR-DYCI2, ANR-MERCI, ERC-REACH directed by Gérard Assayag, and the UPI-CompAI Ircam project.
In this repository we provide the generative core of these applications as a Python library. The Dicy2 Python library defines the core models and tools for the interactive generation of symbolic musical sequences and implements several models, generative heuristics, time management strategies, and architectures of interactive agents.
If using the library, please quote: Nika, J., Déguernel, K., Chemla, A., Vincent, E., & Assayag, G. (2017, October). Dyci2 agents: merging the" free"," reactive", and" scenario-based" music generation paradigms. In International Computer Music Conference. (Article).
- MacOS (the Python library is likely to work on any OS but has only been tested on MacOS)
- Python >= 3.9
- Clone the repository and initialize submodules:
git clone --recurse-submodules git@github.com:DYCI2/Dicy2-python.git - Install dependencies
pip3 install -r requirements.txt
In the root of this repository, there are two examples illustrating two different usages of the Dicy2 Python Library:
generator_tutorial.py: A minimal example on how to quickly generate content using theGeneratorclass. Edit the file to run the different queries or to write your own queriesdicy2_server.py: The server that is used by the Dicy2 Max Library. This illustrates communication over OSC, see the header of the file for more information. Run with./dicy2_server.py.- For an example of communication with a Dicy2 server, see
docs/Example_of_OSC_messages_Dicy2_server.md.
The examples outlined under Running the Dicy2 Python Library are excellent starting points, but there are a couple of other possible classes to start from if you want to integrate the DYCI2 Python Library in your own project:
- The
Generatorclass (dicy2/generator.py) is a good starting point for generating content in an offline setting without managing time - The
GenerationSchedulerclass (dicy2/generation_scheduler.py) is a good starting point for generating content with time management in real-time - The
Agent(dicy2/agent.py) andDICY2Server(dicy2.py) are good starting points for managing one or severalGenerationSchedulersover the OSC protocol.
- For an example of communication with a Dicy2 server, see
docs/Example_of_OSC_messages_Dicy2_server.md. - For a specification on the OSC protocol used in the Dicy2 Python Library, see
docs/osc_protocol.md. Its usage is also thoroughly documented in the header of thedyci2_server.pyfile.
While this use case is unlikely to be relevant for most users, it is possible to build a standalone application of the dicy2_server.py from the Python code using PyInstaller. A pre-built application is already distributed in the release of the Dicy2 Max Library.
See the head of the Makefile for information on building.
Please write to jerome.nika@ircam.fr for any question, or to share with us your projects using Dicy2!
GPL v3