You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,9 @@ If using the library, please quote: __Nika, J., Déguernel, K., Chemla, A., Vinc
38
38
### Running the Dicy2 Python Library
39
39
In the root of this repository, there are two examples illustrating two different usages of the Dicy2 Python Library:
40
40
*`generator_tutorial.py`: A minimal example on how to quickly generate content using the `Generator` class. Edit the file to run the different queries or to write your own queries
41
-
*`dicy2_server.py`: The server that is used by the [Dicy2 Max Library](https://github.com/DYCI2/Dicy2/releases). This illustrates communication over OSC, see the header of the file for more information. Run with `./dicy2_server.py`
41
+
*`dicy2_server.py`: The server that is used by the [Dicy2 Max Library](https://github.com/DYCI2/Dicy2/releases).
42
+
This illustrates communication over OSC, see the header of the file for more information. Run with `./dicy2_server.py`.
43
+
* For an example of communication with a Dicy2 server, see `docs/Example_of_OSC_messages_Dicy2_server.md`.
42
44
43
45
------
44
46
@@ -48,9 +50,11 @@ In the root of this repository, there are two examples illustrating two differen
48
50
The examples outlined under [Running the Dicy2 Python Library](#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:
49
51
* The `Generator` class (`dicy2/generator.py`) is a good starting point for generating content in an offline setting without managing time
50
52
* The `GenerationScheduler` class (`dicy2/generation_scheduler.py`) is a good starting point for generating content with time management in real-time
51
-
* The `Agent` (`dicy2/agent.py`) and `DICY2Server` (`dicy2.py`) are good starting points for managing one or several `GenerationSchedulers` over the OSC protocol
53
+
* The `Agent` (`dicy2/agent.py`) and `DICY2Server` (`dicy2.py`) are good starting points for managing one or several `GenerationSchedulers` over the OSC protocol.
52
54
53
-
For a specification on the OSC protocol used in the Dicy2 Python Library, see `docs/osc_protocol.md`. Its usage is also thoroughly documentented in the header of the `dyci2_server.py` file.
55
+
### Communicating with Dicy2 server.
56
+
* For an example of communication with a Dicy2 server, see `docs/Example_of_OSC_messages_Dicy2_server.md`.
57
+
* 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 the `dyci2_server.py` file.
0 commit comments