Skip to content
Snippets Groups Projects
Commit 00ea5dff authored by nguyed99's avatar nguyed99
Browse files

update README

parent ed4ed61c
No related branches found
No related tags found
No related merge requests found
Pipeline #59687 passed
...@@ -20,11 +20,12 @@ All folders are isolated projects. `cd` into the folder to run/build them. ...@@ -20,11 +20,12 @@ All folders are isolated projects. `cd` into the folder to run/build them.
make init make init
#### Do this happily ever after #### 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 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> 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: ...@@ -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... 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 In the `public` directory
- Run `python -m http.server` - Run `python -m http.server`
- Go to `http://localhost:8000/public` - 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.* *Free and open-source software for all souls! Technical support is, unfortunately, only for group members.*
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment