diff --git a/README.md b/README.md index 1f7d501aa59d1a0151c9f5c6d5159f06c2e3e04c..efeae9c4a58b201fbc0ec43e00ec106819f55f57 100644 --- a/README.md +++ b/README.md @@ -59,29 +59,32 @@ In the `public` directory ## 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` + +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 ../ + cd build/ && poetry install --no-root && cd ../ 1. Activate virtualenv with necessary dependencies - cd build/ && poetry shell && cd ../ + cd build/ && poetry shell && cd ../ 2. Direct simulation of our solar system - python tasks/src/direct_simulation.py + 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 + 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 + python tasks/tests/test_direct_simulation.py 5. Force field simulation of galaxy collision - python tasks/src/ff_simulation_3D.py + 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