diff --git a/Instructions2.txt b/Instructions2.txt deleted file mode 100644 index 0ea0d42be8e8194b2bea41c9abe15c6fc10ea255..0000000000000000000000000000000000000000 --- a/Instructions2.txt +++ /dev/null @@ -1,12 +0,0 @@ -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