From 707b5bf52f27dc69e29e1dc2fd9e30ab379aed3d Mon Sep 17 00:00:00 2001 From: Aaron Fenyes Date: Thu, 7 Aug 2025 20:36:43 -0700 Subject: [PATCH] Update the instructions for running the examples --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d77eef3..cbc20aa 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,13 @@ The latest prototype is in the folder `app-proto`. It includes both a user inter ### Run the engine on some example problems 1. Go into the `app-proto` folder -2. Call `./run-examples` +2. Use `sh` to run the script `tools/run-examples.sh` + * *The script is location-independent, so you can do this from anywhere in the dyna3 repository* + * *The call from the top level of the repository is:* + + ```bash + sh tools/run-examples.sh + ``` * *For each example problem, the engine will print the value of the loss function at each optimization step* * *The first example that prints is the same as the Irisawa hexlet example from the Julia version of the engine prototype. If you go into `engine-proto/gram-test`, launch Julia, and then*