diff --git a/README.md b/README.md index 109c89368f0c90d92d70c3280ac96b85e50199ab..1f7d501aa59d1a0151c9f5c6d5159f06c2e3e04c 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,12 @@ All folders are isolated projects. `cd` into the folder to run/build them. make init #### Do this happily ever after -1. Start a (new) shell and activate the virtual environment +1. Export the root directory of this repo as a `PYTHONPATH` +2. Start a (new) shell and activate the virtual environment poetry shell -2. We are storing Docker images at GitLab's integrated container registry by running: +3. We are storing Docker images at GitLab's integrated container registry by running: docker login git.imp.fu-berlin.de:5000 -u <GITLAB_USERNAME> -p <TOKEN> @@ -51,10 +52,36 @@ For live experience (meaning you enter the container), run: If you change code in `src`, you need to rebuild the image with `bash build/build-image.sh`. The `src` folder can also be mounted in the image, but the assumption is that life is already difficult as it is... -### interactive simulation +### interactive web-based simulation In the `public` directory - Run `python -m http.server` - Go to `http://localhost:8000/public` +## Plug and simulate +*Requirements: python (version 3.11.5) and poetry (version 1.7.1)* +All commands are to be carried out at `root` directory. The root directory of this repo needs to be added to `PYTHONPATH` +0. Create virtualenv with necessary dependencies (do once) + + cd build/ && poetry install --no-root && cd ../ + +1. Activate virtualenv with necessary dependencies + + cd build/ && poetry shell && cd ../ + +2. Direct simulation of our solar system + + python tasks/src/direct_simulation.py + +3. Direct simulation of our solar system with noise in initial data + + python tasks/src/stability_analysis_solar_system.py + +4. Run integration test of trajectories obtained through direct simulation against JPL data + + python tasks/tests/test_direct_simulation.py + +5. Force field simulation of galaxy collision + + python tasks/src/ff_simulation_3D.py *Free and open-source software for all souls! Technical support is, unfortunately, only for group members.* \ No newline at end of file