Documentation - Githubissues

ryosuke-hirai / HORMONE

Repository for hydrodynamical code HORMONE

GNU General Public License v3.0

0 stars 1 forks source link

Documentation #59

Open ryosuke-hirai opened 2 months ago

ryosuke-hirai commented 2 months ago

As the code is now starting to be used more widely, some form of documentation is urgently needed.

Prerequisites (make, gfortran/ifx)
How to install (git clone)
How to compile (setting environment variables, make)
Running tests
Basic workflow (startfile, parameters, extras)
How to restart
Looking at output (output files)
Making new initial conditions
Maybe some pages for each simtype?