Add readme
This commit is contained in:
parent
16bd1cb55f
commit
45f286096e
1 changed files with 14 additions and 0 deletions
14
README.md
Normal file
14
README.md
Normal file
|
@ -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`
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue