User Tools

Site Tools


developers:srctree

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
developers:srctree [2018/01/29 16:34] – created Jean-Michel Beukendevelopers:srctree [2018/02/12 18:25] (current) – [Introduction] Xavier Gonze
Line 2: Line 2:
 ~~NOTOC~~ ~~NOTOC~~
 ===== Introduction ===== ===== Introduction =====
 +
 +THIS FILE IS OUTDATED !!
  
 This page provides a description of the organisation of the abinit package, in terms of subdirectories and their content. This page provides a description of the organisation of the abinit package, in terms of subdirectories and their content.
Line 12: Line 14:
 There are numerous subdirectories in ~abinit, grouped by purpose: There are numerous subdirectories in ~abinit, grouped by purpose:
  
-  *  A. doc/: documentation. +  *  [[developers:srctree#A. doc/|A. doc/]]: documentation. 
-  *  B. src/: core source of ABINIT. +  *  [[developers:srctree#B. The src/* directories|B. src/]]: core source of ABINIT. 
-  *  C. tests/: tests cases, tutorial input/output, and pseudopotentials.+  *  [[developers:srctree#C. The tests/*, Tutorial, and Psps_for_tests directories|C. tests/]]: tests cases, tutorial input/output, and pseudopotentials.
   *  D. config/: the build system of ABINIT.   *  D. config/: the build system of ABINIT.
  
Line 22: Line 24:
 ==== A. doc/ ==== ==== A. doc/ ====
  
-This subdirectory contains all the files that describe information related to the ABINIT package. There are several HTML files, accessible directly from the Web, the other ones being plain-text (or in the markdown format). Many of these files are also ported to the Web frequently.+This subdirectory contains all the files that describe information related to the ABINIT package. There are several <nowiki>HTML</nowiki> files, accessible directly from the Web, the other ones being plain-text (or in the markdown format). Many of these files are also ported to the Web frequently.
  
 **A.1 doc/users** **A.1 doc/users**
Line 36: Line 38:
   *  cut3d_help.html: for the "Cut3D" (cut in three dimensions) utility.   *  cut3d_help.html: for the "Cut3D" (cut in three dimensions) utility.
  
-Other HTML files:+Other <nowiki>HTML</nowiki> files:
  
   *  acknowledgments.html: suggested acknowledgments and references to be inserted in scientific papers the results have been obtained thanks to ABINIT.   *  acknowledgments.html: suggested acknowledgments and references to be inserted in scientific papers the results have been obtained thanks to ABINIT.
   *  bibliography.html: a list of papers that provide the theoretical framework the code is built upon.   *  bibliography.html: a list of papers that provide the theoretical framework the code is built upon.
  
-Some of the other (non-HTML) files are worth to mention (in alphabetical order, and forgetting about possible version numbers or dates):+Some of the other <nowiki>(non-HTML)</nowiki> files are worth to mention (in alphabetical order, and forgetting about possible version numbers or dates):
  
    * band2eps_help: the help file for band2eps (utility to produce encapsulated postscript graph of phonon band structures).    * band2eps_help: the help file for band2eps (utility to produce encapsulated postscript graph of phonon band structures).
Line 57: Line 59:
 **A.3 doc/input_variables** **A.3 doc/input_variables**
  
-  *  many other HTML files describe the input variables (varbas.html, vardev.html, ..., varrlx.html), or constitute an index to these input variables (keyhr.html).+  *  many other <nowiki>HTML</nowiki> files describe the input variables (varbas.html, vardev.html, ..., varrlx.html), or constitute an index to these input variables (keyhr.html).
  
 **A.4 doc/developers** **A.4 doc/developers**
  
-Some of the other (non-HTML) files are worth to mention (in alphabetical order, and forgetting about possible version numbers or dates):+Some of the other <nowiki>(non-HTML)</nowiki> files are worth to mention (in alphabetical order, and forgetting about possible version numbers or dates):
  
   *  context: the context of development of the ABINIT project.   *  context: the context of development of the ABINIT project.
developers/srctree.1517240091.txt.gz · Last modified: 2018/01/29 16:34 by Jean-Michel Beuken