Developers

These topics are for those developing Gemini source code.

Document auto-generation

The documentation is Markdown-based, using FORD. If source code or documentation edits are made, the documentation is regenerated from the top-level gemini directory by:

ford ford.md

The output is under docs/--move it to the gh-pages branch. Upon git push the updated webpage will appear at the GEMINI docs website.

FORD is a Python program, installed via:

pip install ford

Note: leave the LaTeX files and other non-autogenerated documents in doc/ so they don't get disturbed by FORD.

Standard and style

GEMINI is Fortran 2018 compliant and uses two-space indents throughout (to accommodate the many, deeply nested loops). Some of our developers are avid VIM users so please do not use tabs if you plan to push back to the repository or merge.