Wiki

Clone wiki

hamx / Home

hammurabi X wiki

This wiki page is designed as an online documentation, the pdf version will be available in the future.

contribution:

We welcome contributions to the source code from all, with simple rules:

  • Please fork from the master branch first and create you pull request, except for some simple modifications.

  • Notice that the C++ source code follows certain indentation style, and there exist a simple script for auto-correct that, for example, after adding your modifications to your local git, try

    $ ./contrib/utilities/indent-all
    
    this script will try to download some extra files (which is excluded from the git by .gitignore) and apply the indentation automatically, what you need to do is to double check the modifications by
    $ git status
    
    (We acknowledge this indentation method copied from the deal.II library.)

  • Please let us know if you would like to join us as a contributer or co-author in the author list.

  • In terms of scientific suggestions or if you want to enrich the physical models or numerical algorithms, you are very welcomed to contact the authors who are currently taking care of this repository.

Updated