From 45f286096e0ca261f62ccb9c129d3d53b85a5524 Mon Sep 17 00:00:00 2001 From: Fern Garden Date: Sun, 7 Sep 2025 16:37:26 +0800 Subject: [PATCH] Add readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..47c0560 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# 🌏️ ExoPlaSim Docker + +## Environment Variables + +UID: UID of host/guest user. +GID: GID of host/guest user. +MODEL: Path to model (required). + +## Instructions +1. Create an ExoPlaSim model +2. Save it as model.py +3. Set the MODEL environment variable to the directory containing your model.py +4. Run the docker container with `docker compose run -it --rm exoplasim` +