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
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Quickstart
16
16
We have put together a [Docker container](https://hub.docker.com/r/openworm/openworm) that pulls together the major components of our simulation and runs it on your machine. When you get it all running it does the following:
17
17
18
18
1. Run our nervous system model, known as [c302](https://github.com/openworm/c302), on your computer.
19
-
2.Run our 3D worm body model, known as [Sibernetic](https://github.com/openworm/sibernetic), on your computer, using the output of the nervous system model.
19
+
2.In parallel, run our 3D worm body model, known as [Sibernetic](https://github.com/openworm/sibernetic), on your computer, using the output of the nervous system model.
20
20
3. Produce graphs from the nervous system and body model that demonstrate its behavior on your computer for you to inspect.
21
21
4. Produce a movie showing the output of the body model.
22
22
@@ -46,11 +46,11 @@ in addition for Linux instructions.
46
46
**Running**
47
47
48
48
1. Open a terminal and run: `git clone http://github.com/openworm/openworm`; `cd openworm`
49
-
2. Optional: Run `./build.sh` (or `build.cmd` on Windows). If you skip this step, it will download the latets released Docker image from the [OpenWorm Docker hub](https://hub.docker.com/r/openworm/openworm).
49
+
2. Optional: Run `./build.sh` (or `build.cmd` on Windows). If you skip this step, it will download the latest released Docker image from the [OpenWorm Docker hub](https://hub.docker.com/r/openworm/openworm).
50
50
3. Run `./run.sh` (or `run.cmd` on Windows).
51
51
4. About 5-10 minutes of output will display on the screen as the steps run.
52
-
5. The simulation will end. Run `stop.sh` on your system to clean up the running container.
53
-
6. Inspect the output in the `output` directory.
52
+
5. The simulation will end. Run `stop.sh`(`stop.cmd` on Windows) on your system to clean up the running container.
53
+
6. Inspect the output in the `output` directory on your local machine.
54
54
55
55
**Advanced**
56
56
@@ -60,8 +60,8 @@ in addition for Linux instructions.
60
60
61
61
***Other things to try***
62
62
63
-
* Open a terminal and run `./run-shell-only.sh` (or `run-shell-only.cmd` on Windows). This will let you log into the system before it has run `master_openworm.py`. From here you can inspect the internals of the various checked out code bases and installed systems and modify things. Afterwards you'll still need to run `./stop.sh` to clean up.
64
-
* If you wish to modify what gets installed, you should modify Dockerfile. If you want to modify what runs, you should modify `master_openworm.py`. Either way you will need to run `build.sh` in order to rebuild the image locally. Afterwards you can run normally.
63
+
* Open a terminal and run `./run-shell-only.sh` (or `run-shell-only.cmd` on Windows). This will let you log into the container before it has run `master_openworm.py`. From here you can inspect the internals of the various checked out code bases and installed systems and modify things. Afterwards you'll still need to run `./stop.sh` to clean up.
64
+
* If you wish to modify what gets installed, you should modify `Dockerfile`. If you want to modify what runs, you should modify `master_openworm.py`. Either way you will need to run `build.sh` in order to rebuild the image locally. Afterwards you can run normally.
0 commit comments