Licenses outside that list should be used only with a very good reason.
Please comment your projects source release issue if you have to
diverge from the Apache 2.0 license.
You SHOULD claim the copyright.
All source code files should have the following header (python example)
as the very first thing in them
```
# Copyright 2016-2018 The NOMAD Developers Group
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
```
You can adapt this for the comment format of other source code languages.
### clean up you code
You SHOULD clean up you code and make it something you are proud to show, and declare as yours.
For pyhton, [flake8](http://flake8.pycqa.org/en/latest/)(or[pylint](https://www.pylint.org/)) can help standardising the code.
We do not require all things they check, in particular I would *definitely* relax the maximum line length limit, and probably also the variable naming.
If someone is interested in tuning them and making them automatic would be welcome.
You MUST remove all private items (e.g. tokens, keys, other cryptographic information).
### Document your code
You SHOULD document your code where appropriate.
You MUST write a README file. Markdown (README.md) is the canonical format choice.
The README should explain the purpose of your code, the context it is supposed
to be used in, any requirements for using it, and how it can be used.
### Make your code publicly available
You MUST make your code publicly available. The gitlab.rzg.mpg.de is a public
source code hosting service. You just have to make your project public (instead of private or internal). Use
the settings section of your project on GITLab to achieve this.
## The list of all projects in the GITLab organisation NOMAD
### Explanations
The user row shows GITLab users associated with the project. It shows
either owner, masters, or developers depending of whats there.
Not all projects actually have members.
The committer row shows the top 3 authors of the last 100 commits.
These are not GITLab users, but the names used during commit git. These
names depend on how you setup your local git command.
The rows on READMEs and LICENSEs show if there are respective files
(with no, ".md", or ".txt" ending) in the master branch.
The numbers behind READMEs and LICENSEs are the size of the respective file
in bytes.
The commits row refers to the total number of commits in the repository.
|[encyclopedia-dmss](https://gitlab.mpcdf.mpg.de/nomad-lab/encyclopedia-dmss)|Merkulow, Igor (mercury) [master], Vancea, Ioan (ivancea) [master]|Igor Merkulow [6], Ioan Vancea [5], Huhs, Georg (ghuhs) [1]|YES [18487]|NO|internal|13|
|[encyclopedia-gui](https://gitlab.mpcdf.mpg.de/nomad-lab/encyclopedia-gui)|Huhs, Georg (ghuhs) [master], Himanen, Lauri (himanel1) [master], Vancea, Ioan (ivancea) [master]|Hurtado, Iker (ikerh) [89], Vancea, Ioan (ivancea) [10], Lauri Himanen [1]|NO|NO|internal|304|
|[encyclopedia-infrastructure](https://gitlab.mpcdf.mpg.de/nomad-lab/encyclopedia-infrastructure)|Vancea, Ioan (ivancea) [master], Scheidgen, Markus (mscheidg) [master]|Vancea, Ioan (ivancea) [97], Markus Scheidgen [2], Lauri Himanen [1]|YES [776]|NO|private|134|
|[encyclopedia-physics-engine](https://gitlab.mpcdf.mpg.de/nomad-lab/encyclopedia-physics-engine)|Vancea, Ioan (ivancea) [master]|Vancea, Ioan (ivancea) [100]|YES [1862]|NO|internal|240|
|[encyclopedia-pre-processing](https://gitlab.mpcdf.mpg.de/nomad-lab/encyclopedia-pre-processing)|Himanen, Lauri (himanel1) [master], Glawe, Henning (heng) [master], Vancea, Ioan (ivancea) [master]|Markus Scheidgen [56], Georg Huhs [23], Daria M. Tomecka [14]|YES [18642]|NO|internal|1948|
|[encyclopedia-documentation](https://gitlab.mpcdf.mpg.de/nomad-lab/encyclopedia-documentation)|Vancea, Ioan (ivancea) [master], Scheidgen, Markus (mscheidg) [master]||NO|NO|private|NONE|
|[encyclopedia-general](https://gitlab.mpcdf.mpg.de/nomad-lab/encyclopedia-general)|Huhs, Georg (ghuhs) [master], Himanen, Lauri (himanel1) [master], Vancea, Ioan (ivancea) [master]|Huhs, Georg (ghuhs) [62], Georg Huhs [13], Martin Kuban [9]|YES [654]|NO|internal|388|
|[analytics-tools-forcefield](https://gitlab.mpcdf.mpg.de/nomad-lab/analytics-tools-forcefield)|Stella, Martina (stmar) [master], Fekete, Adam (afekete) [master]|Adam Fekete [23], Ádám Fekete [2]|YES [1782]|NO|private|25|
|[parser-big-dft](https://gitlab.mpcdf.mpg.de/nomad-lab/parser-big-dft)|Himanen, Lauri (himanel1) [master], Kivistö, Sami Kristian (skkivist) [master]|Lauri Himanen [15], Fawzi Mohamed [3], Mohamed, Fawzi Roberto (fawzi) [1]|YES [1262]|NO|private|19|
|[parser-castep](https://gitlab.mpcdf.mpg.de/nomad-lab/parser-castep)|Stella, Martina (stmar) [master]|Martina Stella [50], martina stella [43], Fawzi Mohamed [5]|YES [1260]|NO|public|249|
|[parser-cp2k](https://gitlab.mpcdf.mpg.de/nomad-lab/parser-cp2k)|Himanen, Lauri (himanel1) [master]|Himanen, Lauri (himanel1) [46], Lauri Himanen [44], Fawzi Mohamed [6]|YES [2522]|NO|public|186|
|[nomad-emma-usecase](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-emma-usecase)|Alexandrov, Alexander (aalexand) [master], Kunft, Andreas (akunft) [master]|fschueler [44], Alexander Alexandrov [10]|YES [191]|YES [11325]|private|54|
|[Hackaton-ActiCO2](https://gitlab.mpcdf.mpg.de/nomad-lab/Hackaton-ActiCO2)|Valero Montero, Rosendo (rvalero) [master], Larsen, Ask Hjorth (askhl) [master], de Armas, Carlos (cdearmas) [master]|carlos de armas [4], carlos manuel de armas morejon [4], Ask Hjorth Larsen [3]|YES [4053]|NO|internal|12|
|[Hackaton-ClusterX](https://gitlab.mpcdf.mpg.de/nomad-lab/Hackaton-ClusterX)|Troppenz, Maria (mariat) [master], Rigamonti, Santiago (rsant) [master]|Maria Troppenz [46], Santiago Rigamonti [30], Martin Kuban [22]|YES [1329]|YES [154]|internal|360|
|[nomad-idp](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-idp)|Vathsavayi, Sri Harsha (sriv) [master]|Vathsavayi, Sri Harsha (sriv) [3], Harsha [1]|YES [4615]|NO|private|3|
|[magnet-project](https://gitlab.mpcdf.mpg.de/nomad-lab/magnet-project)|Tomecka, Daria M. (datom) [master]|Tomecka, Daria M. (datom) [63]|YES [1123]|NO|private|63|
|[archive-webpage-shiny](https://gitlab.mpcdf.mpg.de/nomad-lab/archive-webpage-shiny)||Sastre, Alfonso (asastre) [24]|YES [850]|NO|private|24|