DeveloperPages

Release version to-do list

The GoldVersionToDo page has the steps for creating a release version of the code.

Notes on Git, GitLab, and Markdown

Git

Official GitLab Git cheat sheet
Notes on helpful Git commit messages
The official Pro Git book and the documentation main page, including this book, the complete reference manual, and a set of learning videos.
Notes for merging a branch to master MergeToMaster.

GitLab

The GitLab help page on this server. GitLab docs master documentation.
Instructions for application-specific access tokens
Git cheat sheet

MarkDown and the Wiki

Gary's notes on markdown are here. A quick and simple introduction of Markdown is here and another more useful GitLab Markdown Cheat sheet. The very complicated documentation for GitLab's version of Markdown is here.
You can clone the wiki repo by clicking on the clone icon. By default you then have the full set of wiki files in the cloudy.wiki directory. You can edit the wiki locally then push the changes back to origin/master
Check that there are no dead links (use a dead link checker, e.g., Check my Links)

Other notes

The monitors for our test suite

MakingContributions

HotFixToDo has the steps for creating a hot-fix entry.

Experimental version of prototype minimal instructions for building Cloudy

The code's StylePage includes a description of some routines that should be used to do common chores.

The DataParser page describes our custom parser specifically designed for efficiently reading data files.

The MultiArrPage describes the new multi_arr structure for allocating and accessing multi-dimensional arrays in Cloudy.

On the VectorMathRoutines page you will find a discussion of all the transcendental math functions that were vectorized using the AVX and later instruction sets.

Our license file is in the root directory of any checkout.