|
1 | 1 | # DyadBotComponents |
2 | 2 |
|
3 | | -## Getting Started |
4 | | - |
5 | | -This library was created with the Dyad Studio VS Code extension. Your Dyad |
6 | | -models should be placed in the `dyad` directory and the files should be |
7 | | -given the `.dyad` extension. Several such files have already been placed |
8 | | -in there to get you started. The Dyad compiler will compile the Dyad models |
9 | | -into Julia code and place it in the `generated` folder. Do not edit the |
10 | | -files in that directory or remove/rename that directory. |
11 | | - |
12 | | -A complete tutorial on using Dyad Studio can be found [here](#). But you |
13 | | -can run the provided example models by doing the following: |
14 | | - |
15 | | -1. Run `Julia: Start REPL` from the command palette. |
16 | | - |
17 | | -2. Type `]`. This will take you to the package manager prompt. |
18 | | - |
19 | | -3. At the `pkg>` prompt, type `instantiate` (this downloads all the Julia libraries |
20 | | - you will need, and the very first time you do it it might take a while). |
21 | | - |
22 | | -4. From the same `pkg>` prompt, type `test`. This will test to make sure the models |
23 | | - are working as expected. It may also take some time but you should eventually |
24 | | - see a result that indicates 2 of 2 tests passed. |
25 | | - |
26 | | -5. Use the `Backspace`/`Delete` key to return to the normal Julia REPL, it should |
27 | | - look like this: `julia>`. |
28 | | - |
29 | | -6. Type `using DyadBotComponents`. This will load your model library. |
30 | | - |
31 | | -7. Type `World()` to run a simulation of the `Hello` model. The first time you run it, |
32 | | - this might take a few seconds, but each successive time you run it, it should be very fast. |
33 | | - |
34 | | -8. To see simulation results type `using Plots` (and answer `y` if asked if you want |
35 | | - to add it as a dependency). |
36 | | - |
37 | | -9. To plot results of the `World` simulation, simply type `plot(World())`. |
38 | | - |
39 | | -10. You can plot variations on that simulation using keyword arguments. For example, |
40 | | - try `plot(World(stop=20, k=4))`. |
0 commit comments