Home

The Optados development wiki

This wiki collects some discussion about various details on Optados. It is mainly of interest if you plan to contribute to the code development. This page and its linked pages are based on those for Wannier90.

How to contribute - please read before doing a pull request!

We kindly request that all contributions to the code follow the advice and recommendations in the Guide for Contributors. This includes information about the requirements for coding style, naming conventions, documentation and commenting, and the addition of examples and test cases for new functionality.

How to write a test (required for pull requests with new code contribution, or changes to the current code)

Read the file test-suite/README in the repository.

Git suggestions and tricks

Merging from the official repository in my fork

Misc

Making a release