Skip to content
Snippets Groups Projects
Commit bba08d90 authored by nicoa96's avatar nicoa96
Browse files

Delete Instructions2.txt

parent 3ec3bea8
No related branches found
No related tags found
3 merge requests!6Na/bhtalgorithmus,!5Na/bhtalgorithmus,!1Na/bhtalgorithmus
Comments for @Natii and all:
1. Please don't change poetry.lock by hand. You should only modify pyproject.toml to add dependencies and their versions. Please check out the use of the 2 commands (https://python-poetry.org/docs/cli/):
poetry update
poetry install
2. Please don't add, commit, and push files in _pycache_
3. Please stick to the repo structure. Implementing integrators is not a complete task. It's a job and the integrators will be called in tasks/src/direct_simulation.py
Therefore, tasks/src/integrators/integrators.py -> jobs/src/integrators.py
4. Simulation is the time evolution of the n-body system, result of which are the time-dependent positions (r) and momenta (p) of the bodies. Visualization is the plotting of the corresponding trajectories either in phase space (r,p) or real space.
5. We run simulations in these 2 scripts tasks/src/direct_simulation.py and tasks/src/ff_simulation.py. Files in jobs/src should only contain functions and dataclasses.
6. Test scripts should look like tests. Please see jobs/tests/test_a_job.py for reference.
7. (!Very important!) Please open an MR so I can comment on your commits directly there. Also it's good for tracking, feedback, updates, etc.
8. Please use docstrings for Python functions, description of module
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment