From 42490c6e302fe5944f607381745eb2c0dd72d915 Mon Sep 17 00:00:00 2001 From: Anthony Scemama Date: Fri, 18 Apr 2014 00:17:22 +0200 Subject: [PATCH] Documentation --- src/BiInts/README.rst | 9 +- src/BiInts/tests/test_ao.ref | 424 ----------------------------------- src/README.rst | 7 +- 3 files changed, 11 insertions(+), 429 deletions(-) delete mode 100644 src/BiInts/tests/test_ao.ref diff --git a/src/BiInts/README.rst b/src/BiInts/README.rst index eb7cefaf..35499607 100644 --- a/src/BiInts/README.rst +++ b/src/BiInts/README.rst @@ -3,11 +3,12 @@ BiInts Module ============= Here, all bi-electronic integrals (:math:`1/r_{12}`) are computed. As they have -4 indices and many are zero, they are stored in a map. -To fetch an AO integral, use the ``get_ao_bielec_integral(i,j,k,l,ao_integrals_map)`` +4 indices and many are zero, they are stored in a map, as defined in +``Utils/map_module.f90``. To fetch an AO integral, use the +``get_ao_bielec_integral(i,j,k,l,ao_integrals_map)`` function, and to fetch and +MO integral, use ``get_mo_bielec_integral(i,j,k,l,mo_integrals_map)`` or +``mo_bielec_integral(i,j,k,l)``. -function, and to fetch and MO integral, use -. Needed Modules ============== diff --git a/src/BiInts/tests/test_ao.ref b/src/BiInts/tests/test_ao.ref deleted file mode 100644 index d34ef769..00000000 --- a/src/BiInts/tests/test_ao.ref +++ /dev/null @@ -1,424 +0,0 @@ -data = { - 'AlCl.ezfio' : { - }, - 'Al.ezfio' : { - }, - 'Al+.ezfio' : { - }, - 'AlH2.ezfio' : { - }, - 'AlH3.ezfio' : { - }, - 'AlH.ezfio' : { - }, - 'BCl.ezfio' : { - }, - 'BeCl.ezfio' : { - }, - 'Be.ezfio' : { - }, - 'Be+.ezfio' : { - }, - 'BeF.ezfio' : { - }, - 'BeH2.ezfio' : { - }, - 'BeH.ezfio' : { - }, - 'BeO.ezfio' : { - }, - 'BeOH.ezfio' : { - }, - 'BeS.ezfio' : { - }, - 'B.ezfio' : { - }, - 'B+.ezfio' : { - }, - 'BH2.ezfio' : { - }, - 'BH3.ezfio' : { - }, - 'BH.ezfio' : { - }, - 'BO.ezfio' : { - }, - 'BS.ezfio' : { - }, - 'C2.ezfio' : { - }, - 'C2H2.ezfio' : { - }, - 'C2H2+.ezfio' : { - }, - 'C2H3.ezfio' : { - }, - 'C2H3+.ezfio' : { - }, - 'C2H4.ezfio' : { - }, - 'C2H4+.ezfio' : { - }, - 'C2H5.ezfio' : { - }, - 'C2H6.ezfio' : { - }, - 'C2H.ezfio' : { - }, - 'CCl.ezfio' : { - }, - 'C-.ezfio' : { - }, - 'C.ezfio' : { - }, - 'C+.ezfio' : { - }, - 'CF.ezfio' : { - }, - 'CH2_1A1.ezfio' : { - }, - 'CH2_3B1.ezfio' : { - }, - 'CH2-.ezfio' : { - }, - 'CH3-.ezfio' : { - }, - 'CH3.ezfio' : { - }, - 'CH4.ezfio' : { - }, - 'CH4+.ezfio' : { - }, - 'CH-.ezfio' : { - }, - 'CH.ezfio' : { - }, - 'Cl2-.ezfio' : { - }, - 'Cl2.ezfio' : { - }, - 'Cl2+.ezfio' : { - }, - 'Cl-.ezfio' : { - }, - 'Cl.ezfio' : { - }, - 'Cl+.ezfio' : { - }, - 'ClH2+.ezfio' : { - }, - 'ClH.ezfio' : { - }, - 'ClH+.ezfio' : { - }, - 'ClS.ezfio' : { - }, - 'ClSiH3.ezfio' : { - }, - 'CN-.ezfio' : { - }, - 'CN.ezfio' : { - }, - 'CO2.ezfio' : { - }, - 'CO.ezfio' : { - }, - 'CO+.ezfio' : { - }, - 'COS.ezfio' : { - }, - 'CP.ezfio' : { - }, - 'CS2.ezfio' : { - }, - 'CS.ezfio' : { - }, - 'CS+.ezfio' : { - }, - 'CSi.ezfio' : { - }, - 'F2.ezfio' : { - }, - 'FAl.ezfio' : { - }, - 'FCl.ezfio' : { - }, - 'FCl+.ezfio' : { - }, - 'F-.ezfio' : { - }, - 'F.ezfio' : { - }, - 'F+.ezfio' : { - }, - 'FH.ezfio' : { - }, - 'FH+.ezfio' : { - }, - 'FMg.ezfio' : { - }, - 'FNa.ezfio' : { - }, - 'FP.ezfio' : { - }, - 'FS.ezfio' : { - }, - 'FSi.ezfio' : { - }, - 'FSiH3.ezfio' : { - }, - 'H2CNH.ezfio' : { - }, - 'H2CO.ezfio' : { - }, - 'H2CPH.ezfio' : { - }, - 'H2CS.ezfio' : { - }, - 'H2.ezfio' : { - }, - 'H2NNH2.ezfio' : { - }, - 'H2PPH2.ezfio' : { - }, - 'H3CCl.ezfio' : { - }, - 'H3CF.ezfio' : { - }, - 'H3CNH2.ezfio' : { - }, - 'H3COH.ezfio' : { - }, - 'H3CSH.ezfio' : { - }, - 'H3SiSiH3.ezfio' : { - }, - 'HBO.ezfio' : { - }, - 'HBS.ezfio' : { - }, - 'HCF.ezfio' : { - }, - 'HCN.ezfio' : { - }, - 'HCO.ezfio' : { - }, - 'HCP.ezfio' : { - }, - 'H.ezfio' : { - }, - 'HNO.ezfio' : { - }, - 'HOCl.ezfio' : { - }, - 'HOF.ezfio' : { - }, - 'HOMg.ezfio' : { - }, - 'HONa.ezfio' : { - }, - 'HOO.ezfio' : { - }, - 'HOOH.ezfio' : { - }, - 'HSSH.ezfio' : { - }, - 'Li2.ezfio' : { - }, - 'LiCl.ezfio' : { - }, - 'Li.ezfio' : { - }, - 'Li+.ezfio' : { - }, - 'LiF.ezfio' : { - }, - 'LiH.ezfio' : { - }, - 'LiN.ezfio' : { - }, - 'LiO.ezfio' : { - }, - 'LiOH.ezfio' : { - }, - 'MgCl.ezfio' : { - }, - 'Mg.ezfio' : { - }, - 'Mg+.ezfio' : { - }, - 'MgH.ezfio' : { - }, - 'MgS.ezfio' : { - }, - 'N2.ezfio' : { - }, - 'N2+.ezfio' : { - }, - 'Na2.ezfio' : { - }, - 'NaCl.ezfio' : { - }, - 'Na.ezfio' : { - }, - 'Na+.ezfio' : { - }, - 'NaH.ezfio' : { - }, - 'N.ezfio' : { - }, - 'N+.ezfio' : { - }, - 'NF.ezfio' : { - }, - 'NH2-.ezfio' : { - }, - 'NH2.ezfio' : { - }, - 'NH3.ezfio' : { - }, - 'NH3+.ezfio' : { - }, - 'NH4+.ezfio' : { - }, - 'NH-.ezfio' : { - }, - 'NH.ezfio' : { - }, - 'NO-.ezfio' : { - }, - 'NO.ezfio' : { - }, - 'NP.ezfio' : { - }, - 'NS.ezfio' : { - }, - 'NSi.ezfio' : { - }, - 'O2Cl.ezfio' : { - }, - 'O2-.ezfio' : { - }, - 'O2.ezfio' : { - }, - 'O2+.ezfio' : { - }, - 'O2S.ezfio' : { - }, - 'O2Si.ezfio' : { - }, - 'O3.ezfio' : { - }, - 'OCl.ezfio' : { - }, - 'O-.ezfio' : { - }, - 'O.ezfio' : { - }, - 'O+.ezfio' : { - }, - 'OH2.ezfio' : { - }, - 'OH2+.ezfio' : { - }, - 'OH3+.ezfio' : { - }, - 'OH-.ezfio' : { - }, - 'OH.ezfio' : { - }, - 'OH+.ezfio' : { - }, - 'OMg.ezfio' : { - }, - 'ONa.ezfio' : { - }, - 'OP-.ezfio' : { - }, - 'OP.ezfio' : { - }, - 'OPH.ezfio' : { - }, - 'OS.ezfio' : { - }, - 'OSi.ezfio' : { - }, - 'P2.ezfio' : { - }, - 'P2+.ezfio' : { - }, - 'PCl.ezfio' : { - }, - 'P-.ezfio' : { - }, - 'P.ezfio' : { - }, - 'PH2-.ezfio' : { - }, - 'PH2.ezfio' : { - }, - 'PH2+.ezfio' : { - }, - 'PH3.ezfio' : { - }, - 'PH3+.ezfio' : { - }, - 'PH4+.ezfio' : { - }, - 'PH-.ezfio' : { - }, - 'PH.ezfio' : { - }, - 'PS.ezfio' : { - }, - 'S2-.ezfio' : { - }, - 'S2.ezfio' : { - }, - 'S-.ezfio' : { - }, - 'S.ezfio' : { - }, - 'S+.ezfio' : { - }, - 'SH2.ezfio' : { - }, - 'SH2+.ezfio' : { - }, - 'SH3+.ezfio' : { - }, - 'SH-.ezfio' : { - }, - 'SH.ezfio' : { - }, - 'SH+.ezfio' : { - }, - 'Si2.ezfio' : { - }, - 'SiCl.ezfio' : { - }, - 'Si-.ezfio' : { - }, - 'Si.ezfio' : { - }, - 'SiH2_1A1.ezfio' : { - }, - 'SiH2_3B1.ezfio' : { - }, - 'SiH2-.ezfio' : { - }, - 'SiH3-.ezfio' : { - }, - 'SiH3.ezfio' : { - }, - 'SiH4.ezfio' : { - }, - 'SiH4+.ezfio' : { - }, - 'SiH-.ezfio' : { - }, - 'SiH.ezfio' : { - }, - 'SiS.ezfio' : { - }, -} diff --git a/src/README.rst b/src/README.rst index f2ee91a7..90272cd7 100644 --- a/src/README.rst +++ b/src/README.rst @@ -91,7 +91,12 @@ subroutines or functions. This enables the possibility easily use the programs with pipes. To print, you should write in an output file provided by the ``Output`` -module. +module. Every module has its own output file. Before printing something, +a timestamp should be put in the output with the ``write_time`` function. +This allows an external script to read all the pieces of the output files +and put them in a sequential order. The format of the output should be +in ReStructured Text for easy transformation of the output data to pdf, +HTML, man, etc. Creating a shell script