Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"name": "OpenWorm devcontainer",
"runArgs": [
"--device",
"/dev/dri",
"--device",
"/dev/kfd",
"--group-add",
"video",
"--group-add",
"render",
"--volume",
"/tmp/.X11-unix:/tmp/.X11-unix:rw"
],
"build": {
"dockerfile": "../Dockerfile"
},
"customizations": {
"vscode": {
"settings": {},
"extensions": []
}
},
"containerEnv": {
"XDG_SESSION_TYPE": "${localEnv:XDG_SESSION_TYPE}",
"DISPLAY": ":0"
},
"postCreateCommand": "touch ~/.bashrc",
"remoteUser": "ow"
}
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,25 @@ We have put together a [Docker container](https://hub.docker.com/r/openworm/open

**NOTE**: Running the simulation for the full amount of time would produce content like the above. However, in order to run in a reasonable amount of time, **the default run time for the simulation is limited**. As such, you will see only a partial output, equivalent to about 5% of run time, compared to the examples above. To extend the run time, use the `-d` argument as described below.

## Quickstart with devcontainer

This project supports [devcontainer](https://containers.dev/). If you already configured devcontainer support in vscode, simply open this project with vscode and then select "reopen project in container". Use this [guide](https://code.visualstudio.com/docs/devcontainers/tutorial) if you want to configure vscode with devcontainer support.

From the devcontainer terminal, you can run the below commands

Sibernetic
```
ow@2b6d2f0ccfe5:/workspaces/OpenWorm$ cd ~/sibernetic/
ow@2b6d2f0ccfe5:~/sibernetic$ ./Release/Sibernetic -f worm
```
If your devcontainer set-up is working correctly, you should see something like this ![sibernetic worm](img/sibernetic_worm_demo.png)

Opemworm
```
ow@2b6d2f0ccfe5:/workspaces/OpenWorm$ OW_OUT_DIR=output DISPLAY=:44 python3 master_openworm.py
```


## Installation

### Pre-requisites
Expand Down
Binary file added img/sibernetic_worm_demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.