Explore Abinit and around
- ABINIT Coding
- Doc for new developers
- Organizing events
Organisation of the ABINIT June 2018 beautification, Monday 4 June - Wednesday 14 June 2018.
I expect your contributions to be in a branch named “user_name”/beauty. So, please start from your develop branch (v8.9.3 of ABINIT), branch your own “beauty” branch, upgrade it to the latest trunk/develop, work in it, then issue a merge request (using Gitlab) from “user_name”/beauty to trunk/develop.
then beautify the code, then issue the proper merge request to trunk/develop, then mention in the task list that you have done the job !
This beautification will be focused on the documentation. Indeed, as a response to the recommendations made at the last developer workshop, in Frejus May 2017, “topics” have been introduced and lead to completion, a centralized bibliography database has been set up, and a new global infrastructure based on mkdocs (and markdown) has been established. However:
As an indication, each contributor might have to dedicate about three hours to this work (including, if not yet done, reading the mkdocs documentation and possibly training a bit with the mksite script). By the way, suggestions for improvements of the mkdocs infrastructure is also welcome, see the dedicated page.
Check first whether it exists already in the bibliographical database (file doc/abiref.bib), and if so, simply refer to it using a “cite” wikilink. Otherwise, introduce the adequate bibtex information
All the needed documentation is available at :
Going through it for the first time might be 15-20 minutes.
Training might be another 15 minutes (e.g. starting the server with
./mksite.py serve –dirtyreload,
then trying to make some fake modifications).
Most of the following files have been assigned to contributors :
So, the work will consists in the beautification of 46 *.md files, 17 varsets and 3 remaining variables*.py files. To summarize, 66 tasks to be distributed.
Moreover, as the addition of new tutorial and documentation is facilitated with respect to the previous procedure, adding new tutorials or documentation for new executables might also be done by volunteers, or any filling of holes in the documentation. For example, multibinit and tdep documentation is missing (but is underway for multibinit !), the tutorial on spin/spin-orbit could be extended, the tutorial on source_code should be rewritten from scratch…