Just wanted to start making contribution to the OpenWorm project. Getting on board with some changes right now.
Enhanced README.md with more detailed and user-friendly instructions
Added clearer steps for running the Docker container, including running the nervous system model (c302) and the 3D worm body model (Sibernetic).
Included example output images and a note about the default limited run time.
Expanded installation section with pre-requisites for free space, RAM, and git installation.
Provided detailed installation instructions for Docker and handling limited free space with external storage.
Updated running instructions, including cloning the repository, optionally building the Docker image, running the container, cleaning up, and inspecting the output.
Added advanced usage tips, such as modifying the simulation duration with the -d argument, logging into the container, modifying the Dockerfile, and running build.sh.
Expanded FAQ section with explanations on the Docker container's purpose, modifying the simulation without rebuilding, accessing additional data output, and the difference between exit and stop.sh.
Added instructions for re-entering a container after exiting without stopping it.
These changes provide better clarity and more helpful context for users to effectively run and modify the OpenWorm simulation using Docker.
Hi all,
Just wanted to start making contribution to the OpenWorm project. Getting on board with some changes right now.
Enhanced README.md with more detailed and user-friendly instructions
-d
argument, logging into the container, modifying the Dockerfile, and runningbuild.sh
.exit
andstop.sh
.These changes provide better clarity and more helpful context for users to effectively run and modify the OpenWorm simulation using Docker.
How do we view this?