diff --git a/README.md b/README.md index 58d88f1000f09c457fdcacc5a11a917fef6d2c1d..315b24208bf1de01eccf6095aec541d07f63d2e1 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,13 @@ Git for summerstudent project on evolution of open cluster (see project description) -# TODO: +A manual to run the code and get output in correct format is present: `nbody6_quick_guide.md`. + + + +# TODO list: - [ ] Get nbody6 working and get to know the code - - [ ] Make appointment with max and go through things + - [x] Make appointment with max and go through things - [ ] Make it fairly easy for the student to work with nbody6 - [ ] make output scripts - [ ] Create environment to run things on. i.e. go to IT @@ -12,3 +16,5 @@ Git for summerstudent project on evolution of open cluster (see project descript - [x] Write up a more solid form of the project description - [ ] Stay in contact with Mark and Fabio, keep them in the loop of any further advice. Also discuss with them semi regularly about the topic. + +- [] Create quickstart manual for us diff --git a/manuals/nbody6++_manual.pdf b/manuals/nbody6++_manual.pdf new file mode 100644 index 0000000000000000000000000000000000000000..d64a71ce1b9fb5cc8630c64462e263f01457b7ad Binary files /dev/null and b/manuals/nbody6++_manual.pdf differ diff --git a/nbody6_quick_guide.md b/nbody6_quick_guide.md new file mode 100644 index 0000000000000000000000000000000000000000..f63d1d418c42bae94d72ce91c067670875956b84 --- /dev/null +++ b/nbody6_quick_guide.md @@ -0,0 +1,28 @@ +# Quick guide to running nbody6++ + +## prerequisites/documents/scripts: +* This doc +* nbody6++\_manual.pdf +* nbody6++ itself: +* readout script: +* config generator script: `python_scripts_for_nbody6/nbody6_config_generator.py` + +## Tutorial +### Set up config +We will go through the configuration file, and what all the variables mean, but they are also described in nbody6++\_manual.pdf. + +The formatting for the config file is very plain, but I have created a script to generate the config files called `python_scripts_for_nbody6/nbody6_config_generator.py` + +### To run the code: +To run a simulation we must pass the config file to the executable of nbody6++. + +``` +/vol/ph/astro_code/dhendriks/nbody6/ < "full path to configuration file." +``` + +Based on the input configuration this file will run until it gets terminated (by the code or by you). + +### Reading out the + + + diff --git a/python_scripts_for_nbody6/nbody6_config_generator.py b/python_scripts_for_nbody6/nbody6_config_generator.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391