scnc
/
abinit
mirror of https://github.com/abinit/abinit.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
abinit/scripts
History
trunk c2237740a1 Merge commit '76f6bebef6' into _sponce-10.2 2024-10-31 05:54:01 +01:00
..
bbtools Upgrade copyright yeat from 2023 to 2024, final phase. To be checked ... 2024-03-07 05:27:13 +01:00
configure Upgrade copyright yeat from 2023 to 2024, final phase. To be checked ... 2024-03-07 05:27:13 +01:00
deprecated Remove obsolete scripts 2018-10-21 16:41:56 +02:00
post_processing Merge commit '76f6bebef6' into _sponce-10.2 2024-10-31 05:54:01 +01:00
pre_processing Remove obsolete scripts 2018-10-21 16:41:56 +02:00
README.md More markdown files 2016-07-09 15:35:09 +02:00

README.md

ABINIT users scripts

A collection of scripts contributed by various users. The scripts are organized as follow:

  • configure To ease configuration/compilation of ABINIT.

  • post_processing To plot, extract or modify output data.

  • pre_processing To check, visualize or manipulate input data.

  • deprecated Scripts that are not documented or suspected to be broken. Will eventually be removed. If you think a deprecated script should not be kept, contact the developers via the forum.

HOW TO CONTRIBUTE

Before commiting a new script to this directory, please make sure it contains full documentation. If your script is a single file, include comments at the head of the file. If you want to add a collection of scripts, you can gather them in a sub-directory and include a README file.

Proper documentation should contain:

  • A one-liner description of the program. (to be added to the local README file)

  • A literal description of the program.

  • The data on which the script operates.

  • Usage (how to feed the inputs to your script.)

  • The output data produced.

  • Author information (name and email address).