diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..3bedc6c --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,12 @@ +pages: + stage: deploy + script: + - mkdir .public + - cp -r docs/* .public + - mv .public public + artifacts: + paths: + - public + only: + - dev + diff --git a/Makefile b/Makefile index 42b12bb..dc58ec9 100644 --- a/Makefile +++ b/Makefile @@ -1,16 +1,22 @@ # Frontend to dune. +# No implicit rules +MAKEFLAGS += --no-builtin-rules +.SUFFIXES: + DIRS=$(shell ls */README.org | sed "s|/README.org||g") DOCS=$(patsubst %, docs/%.html, $(DIRS)) -.PHONY: default build install uninstall test clean +.PHONY: default build install uninstall test clean doc default: build -docs/%.html: %/README.org +docs/%.html: %/README.org %/lib/*.ml %/lib/*.mli %/test/*.ml + - echo $^ - ./bin/tangle.sh $* - ./bin/build_doc.sh $* + - ./bin/build_doc.sh docs doc: $(DOCS) diff --git a/bin/build_doc.sh b/bin/build_doc.sh index b08eb8b..3c2a531 100755 --- a/bin/build_doc.sh +++ b/bin/build_doc.sh @@ -14,15 +14,21 @@ fi DIR=${1%/} -rm -f docs/${DIR}.org -for i in ${DIR}/README.org ${DIR}/[a-z]*.org -do - cat $i >> docs/${DIR}.org -done - CONFIG="--load docs/htmlize.el --load docs/config.el" +if [[ ${DIR} == "docs" ]] ; then + + emacs --debug-init --batch $CONFIG docs/index.org -f org-html-export-to-html + +else + rm -f docs/${DIR}.org + for i in ${DIR}/README.org ${DIR}/[a-z]*.org + do + cat $i >> docs/${DIR}.org + done + + emacs --debug-init --batch $CONFIG docs/${DIR}.org -f org-html-export-to-html \ + && rm docs/${DIR}.org +fi -emacs --debug-init --batch $CONFIG docs/${DIR}.org -f org-html-export-to-html \ -&& rm docs/${DIR}.org diff --git a/docs/ao.html b/docs/ao.html index 810efff..fc409f7 100644 --- a/docs/ao.html +++ b/docs/ao.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Atomic Orbitals @@ -226,13 +226,13 @@

Atomic Orbitals

-
"Atomic basis set"
+
"Atomic basis set"
 

Author: Anthony Scemama

-

Created: 2021-01-01 Fri 17:04

+

Created: 2021-01-01 Fri 18:06

Validate

diff --git a/docs/common.html b/docs/common.html index 5bfbf50..a9bcce7 100644 --- a/docs/common.html +++ b/docs/common.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Common @@ -251,140 +251,140 @@

Table of Contents

-
"Utility functions used by all the other directories."
+
"Utility functions used by all the other directories."
 
-
-

1 Angular Momentum

+
+

1 Angular Momentum

Azimuthal quantum number, repsesented as \( s,p,d,\dots \) .

-
-

1.1 Type

+
+

1.1 Type

-
type t =
+
type t =
   | S | P | D | F | G | H | I | J | K | L | M | N | O
   | Int of int
 
@@ -411,8 +411,8 @@ quartets, use in the two-electron operators.
 
-
-

1.2 Conversions

+
+

1.2 Conversions

val of_char : char -> t
@@ -461,7 +461,7 @@ quartets, use in the two-electron operators.
 
 
 
-
+
 Angular_momentum.of_char 'p';;
 - : Angular_momentum.t = P
 
@@ -480,8 +480,8 @@ Angular_momentum.(to_string D);;
 
-
-

1.3 Shell functions

+
+

1.3 Shell functions

val n_functions : t -> int
@@ -510,7 +510,7 @@ Angular_momentum.(to_string D);;
 
 
 
-
+
 Angular_momentum.(n_functions D) ;;
 - : int = 6
 
@@ -523,8 +523,8 @@ Angular_momentum.( zkey_array (Doublet (P,S)) );;
 
-
-

1.4 Arithmetic

+
+

1.4 Arithmetic

val ( + ) : t -> t -> t
@@ -532,7 +532,7 @@ Angular_momentum.( zkey_array (Doublet (P,S)) );;
 
-
+
 Angular_momentum.(D + P);;
 - : Angular_momentum.t = F
 
@@ -542,8 +542,8 @@ Angular_momentum.(F - P);;
 
-
-

1.5 Printers

+
+

1.5 Printers

Printers can print as a string (default) or as an integer. @@ -558,12 +558,12 @@ Printers can print as a string (default) or as an integer.

-
-

1.6 TODO Tests

+
+

1.6 TODO Tests

-
-

2 Bit string

+
+

2 Bit string

We define here a data type to handle bit strings efficiently. When @@ -575,8 +575,8 @@ bit string as a multi-precision integer.

-
-

2.1 Type

+
+

2.1 Type

type t
@@ -585,8 +585,8 @@ bit string as a multi-precision integer.
 
-
-

2.2 General implementation

+
+

2.2 General implementation

val of_int : int -> t
@@ -735,13 +735,13 @@ bit string as a multi-precision integer.
 
 
 
-
+
 Bitstring.of_int 15;;
 - : Bitstring.t =
 ++++------------------------------------------------------------
 
-
+
 Bitstring.(shift_left (of_int 15) 2);;
 - : Bitstring.t =
 --++++----------------------------------------------------------
@@ -761,7 +761,7 @@ Bitstring.(testbit (of_int 15) 4);;
 - : bool = false
 
-
+
 Bitstring.(logor (of_int 15) (of_int 73));;
 - : Bitstring.t =
 ++++--+---------------------------------------------------------
@@ -776,7 +776,7 @@ Bitstring.(logxor (of_int 15) (of_int 73));;
 
-
+
 Bitstring.(plus_one (of_int 15));;
 - : Bitstring.t =
 ----+-----------------------------------------------------------
@@ -787,7 +787,7 @@ Bitstring.(minus_one (of_int 15));;
 
-
+
 Bitstring.(trailing_zeros (of_int 12));;
 - : int = 2
 
@@ -798,12 +798,12 @@ Bitstring.(popcount (of_int 15));;
 - : int = 4
 
-
+
 Bitstring.(to_list (of_int 45));;
 - : int list = [1; 3; 4; 6]
 
-
+
    Bitstring.permutations 2 4;;
 - : Bitstring.t list =
 [++--------------------------------------------------------------;
@@ -816,8 +816,8 @@ Bitstring.(to_list (of_int 45));;
 
-
-

2.3 Printers

+
+

2.3 Printers

val pp : Format.formatter -> t -> unit
@@ -827,13 +827,13 @@ Bitstring.(to_list (of_int 45));;
 
-
-

3 Charge

+
+

3 Charge

-
-

3.1 Type

+
+

3.1 Type

type t
@@ -846,8 +846,8 @@ This type should be used for all charges in the program (electrons, nuclei, 
 
-
-

3.2 Conversions

+
+

3.2 Conversions

val of_float : float -> t
@@ -863,8 +863,8 @@ This type should be used for all charges in the program (electrons, nuclei, 
 
-
-

3.3 Simple operations

+
+

3.3 Simple operations

val ( + ) : t -> t -> t
@@ -877,8 +877,8 @@ This type should be used for all charges in the program (electrons, nuclei, 
 
-
-

3.4 Printers

+
+

3.4 Printers

val pp : Format.formatter -> t -> unit
@@ -888,8 +888,8 @@ This type should be used for all charges in the program (electrons, nuclei, 
 
-
-

4 Command line

+
+

4 Command line

This module is a wrapper around the Getopt library and helps to @@ -945,11 +945,11 @@ Then, define what to do with the arguments:

-
-

4.1 Type

+
+

4.1 Type

-
type short_opt     = char
+
type short_opt     = char
 type long_opt      = string
 type optional      = Mandatory | Optional
 type documentation = string
@@ -980,8 +980,8 @@ don't (ls -l) and for some arguments the argument is optional
 
-
-

4.2 Mutable attributes

+
+

4.2 Mutable attributes

All the options are stored in the hash table dict where the key @@ -1011,8 +1011,8 @@ Function to create an anonymous argument.

-
-

4.3 Query functions

+
+

4.3 Query functions

val get       : long_opt -> string option
@@ -1050,8 +1050,8 @@ Function to create an anonymous argument.
 
-
-

4.4 Specification

+
+

4.4 Specification

val set_specs : description list -> unit
@@ -1066,16 +1066,16 @@ Sets the specifications of the current program from a list of
 
-
-

5 Constants

+
+

5 Constants

All constants used in the program.

-
-

5.1 Thresholds

+
+

5.1 Thresholds

val epsilon          : float
@@ -1106,8 +1106,8 @@ All constants used in the program.
 
-
-

5.2 Mathematical constants

+
+

5.2 Mathematical constants

val pi             : float
@@ -1162,8 +1162,8 @@ All constants used in the program.
 
-
-

5.3 Physical constants

+
+

5.3 Physical constants

val a0       : float
@@ -1207,8 +1207,8 @@ All constants used in the program.
 
-
-

6 Coordinate

+
+

6 Coordinate

Coordinates in 3D space. @@ -1221,11 +1221,11 @@ module.

-
-

6.1 Type

+
+

6.1 Type

-
type bohr 
+
type bohr 
 type angstrom 
 
 type xyz = {
@@ -1244,8 +1244,8 @@ module.
 
-
-

6.2 Creation

+
+

6.2 Creation

val make          : 'a point -> t
@@ -1282,8 +1282,8 @@ module.
 
-
-

6.3 Conversion

+
+

6.3 Conversion

val bohr_to_angstrom : bohr point -> angstrom point
@@ -1314,8 +1314,8 @@ module.
 
-
-

6.4 Vector operations

+
+

6.4 Vector operations

val neg    : t -> t
@@ -1374,7 +1374,7 @@ module.
 
 
 
-
+
 Coordinate.neg { x=1. ; y=2. ; z=3. } ;;
 - : Coordinate.t =  -1.0000  -2.0000  -3.0000
 
@@ -1400,8 +1400,8 @@ Coordinate.(
 
-
-

6.5 Printers

+
+

6.5 Printers

val pp : Format.formatter -> t -> unit
@@ -1417,13 +1417,13 @@ Coordinates can be printed in bohr or angstrom.
 
-
-

7 Non-negative float

+
+

7 Non-negative float

-
-

7.1 Type

+
+

7.1 Type

type t = private float
@@ -1432,8 +1432,8 @@ Coordinates can be printed in bohr or angstrom.
 
-
-

7.2 Conversions

+
+

7.2 Conversions

val of_float        : float -> t
@@ -1453,16 +1453,16 @@ The unsafe variant doesn't do this check.
 
-
-

8 Powers

+
+

8 Powers

Contains powers of x, y and z describing the polynomials in atomic basis sets.

-
-

8.1 Type

+
+

8.1 Type

type t = private {
@@ -1480,8 +1480,8 @@ Contains powers of x, y and z describing the polynomials in atomic basis sets.
 
-
-

8.2 Conversions

+
+

8.2 Conversions

val of_int_tuple : int * int * int -> t
@@ -1489,7 +1489,7 @@ Contains powers of x, y and z describing the polynomials in atomic basis sets.
 
-
+
 Powers.of_int_tuple (2,3,1);;
 - : Powers.t = x^2 + y^3 + z^1
 
@@ -1499,8 +1499,8 @@ Powers.(to_int_tuple (of_int_tuple (2,3,1)));;
 
-
-

8.3 Operations

+
+

8.3 Operations

val get  : Coordinate.axis -> t -> int
@@ -1535,7 +1535,7 @@ Powers.(to_int_tuple (of_int_tuple (2,3,1)));;
 
 
 
-
+
 Powers.get Coordinate.Y (Powers.of_int_tuple (2,3,1));;
 - : int = 3
 
@@ -1549,8 +1549,8 @@ Powers.decr Coordinate.Y (Powers.of_int_tuple (2,3,1));;
 
-
-

8.4 Printers

+
+

8.4 Printers

val pp : Format.formatter -> t -> unit
@@ -1560,8 +1560,8 @@ Powers.decr Coordinate.Y (Powers.of_int_tuple (2,3,1));;
 
-
-

9 QCaml

+
+

9 QCaml

QCaml-specific parameters @@ -1596,8 +1596,8 @@ QCaml-specific parameters

-
-

10 Range

+
+

10 Range

A range is a sorted list of integers in an interval. @@ -1612,8 +1612,8 @@ A range is a sorted list of integers in an interval.

-
-

10.1 Type

+
+

10.1 Type

type t
@@ -1622,8 +1622,8 @@ A range is a sorted list of integers in an interval.
 
-
-

10.2 Conversion

+
+

10.2 Conversion

val of_string   : string -> t
@@ -1634,8 +1634,8 @@ A range is a sorted list of integers in an interval.
 
-
-

10.3 Printers

+
+

10.3 Printers

val pp : Format.formatter -> t -> unit
@@ -1645,16 +1645,16 @@ A range is a sorted list of integers in an interval.
 
-
-

11 Spin

+
+

11 Spin

Electron spin

-
-

11.1 Type

+
+

11.1 Type

type t = Alfa | Beta
@@ -1669,8 +1669,8 @@ letters as Beta, so the alignment of the code is nicer.
 
-
-

11.2 Functions

+
+

11.2 Functions

val other : t -> t
@@ -1683,8 +1683,8 @@ Returns the opposite spin
 
-
-

11.3 Printers

+
+

11.3 Printers

val pp : Format.formatter -> t -> unit
@@ -1694,8 +1694,8 @@ Returns the opposite spin
 
-
-

12 Util

+
+

12 Util

Utility functions. @@ -1703,8 +1703,8 @@ Utility functions.

-
-

12.1 External C functions

+
+

12.1 External C functions

@@ -1748,8 +1748,8 @@ Utility functions.
-
-

12.1.1 Erf

+
+

12.1.1 Erf

external erf_float : float -> float = "erf_float_bytecode" "erf_float" [@@unboxed] [@@noalloc]
@@ -1758,8 +1758,8 @@ Utility functions.
 
-
-

12.1.2 Erfc

+
+

12.1.2 Erfc

external erfc_float : float -> float = "erfc_float_bytecode" "erfc_float" [@@unboxed] [@@noalloc]
@@ -1768,8 +1768,8 @@ Utility functions.
 
-
-

12.1.3 Gamma

+
+

12.1.3 Gamma

external gamma_float : float -> float = "gamma_float_bytecode" "gamma_float" [@@unboxed] [@@noalloc]
@@ -1778,8 +1778,8 @@ Utility functions.
 
-
-

12.1.4 Popcnt

+
+

12.1.4 Popcnt

val popcnt : int64 -> int
@@ -1788,8 +1788,8 @@ Utility functions.
 
-
-

12.1.5 Trailz

+
+

12.1.5 Trailz

val trailz : int64 -> int
@@ -1798,8 +1798,8 @@ Utility functions.
 
-
-

12.1.6 Leadz

+
+

12.1.6 Leadz

val leadz : int64 -> int
@@ -1808,13 +1808,13 @@ Utility functions.
 
-
-

12.1.7 Test

+
+

12.1.7 Test

-
-

12.2 General functions

+
+

12.2 General functions

val fact : int -> float
@@ -1887,8 +1887,8 @@ Utility functions.
 
-
-

12.3 Functions related to the Boys function

+
+

12.3 Functions related to the Boys function

val incomplete_gamma : alpha:float -> float -> float
@@ -1945,8 +1945,8 @@ where \(\gamma\) is the incomplete gamma function.
 
-
-

12.4 List functions

+
+

12.4 List functions

val list_some  : 'a option list -> 'a list
@@ -1983,8 +1983,8 @@ where \(\gamma\) is the incomplete gamma function.
 
-
-

12.5 Array functions

+
+

12.5 Array functions

val array_range   : int -> int -> int array
@@ -2021,8 +2021,8 @@ where \(\gamma\) is the incomplete gamma function.
 
-
-

12.6 Stream functions

+
+

12.6 Stream functions

val stream_range   : int -> int -> int Stream.t
@@ -2059,8 +2059,8 @@ where \(\gamma\) is the incomplete gamma function.
 
-
-

12.7 Printers

+
+

12.7 Printers

val pp_float_array_size   : Format.formatter -> float array -> unit
@@ -2107,7 +2107,7 @@ where \(\gamma\) is the incomplete gamma function.
 
 
 
-
+
 pp_float_array_size:
 [ 6:   1.000000   1.732051   1.732051   1.000000   1.732051   1.000000 ]
 
@@ -2130,8 +2130,8 @@ pp_bitstring 14:
 
-
-

13 Zkey

+
+

13 Zkey

Encodes the powers of x, y, z in a compact form, suitable for being @@ -2144,7 +2144,7 @@ The small integers x, y and z are stored compactly in this 126-bits space:

-
+
                                 Left                                                                Right
  3 [--------------------------------------------------------------]       [------------------|---------------|---------------|---------------]
                                                                                                      x               y               z        
@@ -2165,8 +2165,8 @@ The values of x,y,z should be positive and should not exceed 32767 for
 

-
-

13.1 Types

+
+

13.1 Types

type t 
@@ -2182,8 +2182,8 @@ The values of x,y,z should be positive and should not exceed 32767 for
 
-
-

13.2 Conversions

+
+

13.2 Conversions

val of_powers_three  : Powers.t -> t
@@ -2262,8 +2262,8 @@ The values of x,y,z should be positive and should not exceed 32767 for
 
-
-

13.3 Functions for hash tables

+
+

13.3 Functions for hash tables

val hash    : t -> int
@@ -2300,8 +2300,8 @@ The values of x,y,z should be positive and should not exceed 32767 for
 
-
-

13.4 Printers

+
+

13.4 Printers

val pp : Format.formatter -> t -> unit
@@ -2311,16 +2311,16 @@ The values of x,y,z should be positive and should not exceed 32767 for
 
-
-

14 Zmap

+
+

14 Zmap

A hash table where the keys are Zkey

-
-

14.1 Type

+
+

14.1 Type

include module type of Hashtbl.Make(Zkey)
@@ -2332,7 +2332,7 @@ A hash table where the keys are Zkey
 

Author: Anthony Scemama

-

Created: 2021-01-01 Fri 17:05

+

Created: 2021-01-01 Fri 17:56

Validate

diff --git a/docs/gaussian.html b/docs/gaussian.html index 7516a12..5c7ae72 100644 --- a/docs/gaussian.html +++ b/docs/gaussian.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Gaussian @@ -226,13 +226,13 @@

Gaussian

-
"Gaussian basis sets"
+
"Gaussian basis sets"
 

Author: Anthony Scemama

-

Created: 2021-01-01 Fri 17:04

+

Created: 2021-01-01 Fri 17:56

Validate

diff --git a/docs/gaussian_integrals.html b/docs/gaussian_integrals.html index c6f10ee..41bc36f 100644 --- a/docs/gaussian_integrals.html +++ b/docs/gaussian_integrals.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Gaussian integrals @@ -226,13 +226,13 @@

Gaussian integrals

-
"Integrals on the Gaussian basis sets"
+
"Integrals on the Gaussian basis sets"
 

Author: Anthony Scemama

-

Created: 2021-01-01 Fri 17:04

+

Created: 2021-01-01 Fri 17:56

Validate

diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..89f88a5 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,250 @@ + + + + + + + +QCaml documentation + + + + + + + + + + + + +
+

QCaml documentation

+ +
+
+

Author: Anthony Scemama

+

Created: 2021-01-01 Fri 18:06

+

Validate

+
+ + diff --git a/docs/index.org b/docs/index.org new file mode 100644 index 0000000..78e404e --- /dev/null +++ b/docs/index.org @@ -0,0 +1,14 @@ +#+TITLE: QCaml documentation +#+SETUPFILE: ../docs/org-html-themes/org/theme-readtheorg.setup + + #+NAME: list + #+begin_src sh :exports results :results org +ls ../*/README.org \ + | cut -d '/' -f 2 \ + | sed 's/[^.]*/- \[\[.\/&\.html\]\[\u&\]\]/g' + #+end_src + + + + + diff --git a/docs/linear_algebra.html b/docs/linear_algebra.html index d549a27..089e78c 100644 --- a/docs/linear_algebra.html +++ b/docs/linear_algebra.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Linear Algebra @@ -226,13 +226,13 @@

Linear Algebra

-
"Linear algebra utilities of QCaml libraries."
+
"Linear algebra utilities of QCaml libraries."
 

Author: Anthony Scemama

-

Created: 2021-01-01 Fri 17:04

+

Created: 2021-01-01 Fri 17:56

Validate

diff --git a/docs/mo.html b/docs/mo.html index dfa7821..083d029 100644 --- a/docs/mo.html +++ b/docs/mo.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Molecular orbitals @@ -229,36 +229,36 @@

Table of Contents

-
"Molecular orbitals"
+
"Molecular orbitals"
 
-
-

1 Frozen core

+
+

1 Frozen core

Defines how the core electrons are frozen, for each atom.

-
-

1.1 Type

+
+

1.1 Type

-
type kind =
+
type kind =
   | All_electron
   | Small
   | Large
@@ -272,8 +272,8 @@ Defines how the core electrons are frozen, for each atom.
 
-
-

1.2 Creation

+
+

1.2 Creation

val make : kind -> Particles.Nuclei.t -> t
@@ -309,7 +309,7 @@ Defines how the core electrons are frozen, for each atom.
 
 
 
-
+
 let f = Frozen_core.(make Small nuclei) ;;
 val f : Frozen_core.t = [|0; 2; 2; 0|]
 
@@ -319,8 +319,8 @@ val f : Frozen_core.t = [|0; 2; 2; 0|]
 
-
-

1.3 Access

+
+

1.3 Access

val num_elec : t -> int
@@ -349,7 +349,7 @@ val f : Frozen_core.t = [|0; 2; 2; 0|]
 
 
 
-
+
 Frozen_core.num_elec f ;;
 - : int = 4
 
@@ -359,8 +359,8 @@ Frozen_core.num_mos f ;;
 
-
-

1.4 Printers

+
+

1.4 Printers

val pp : Format.formatter -> t -> unit
@@ -372,7 +372,7 @@ Frozen_core.num_mos f ;;
 

Author: Anthony Scemama

-

Created: 2021-01-01 Fri 17:04

+

Created: 2021-01-01 Fri 17:56

Validate

diff --git a/docs/operators.html b/docs/operators.html index 83e9da2..b27795d 100644 --- a/docs/operators.html +++ b/docs/operators.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Operators @@ -226,13 +226,13 @@

Operators

-
"Parameteried operators, such as F12 and range-separation"
+
"Parameteried operators, such as F12 and range-separation"
 

Author: Anthony Scemama

-

Created: 2021-01-01 Fri 17:04

+

Created: 2021-01-01 Fri 17:56

Validate

diff --git a/docs/particles.html b/docs/particles.html index 9d54cf7..76df1a5 100644 --- a/docs/particles.html +++ b/docs/particles.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Common @@ -251,75 +251,75 @@

Table of Contents

-
"Information relative to particles (electrons and nuclei)."
+
"Information relative to particles (electrons and nuclei)."
 
-
-

1 Electrons

+
+

1 Electrons

Data structure which contains the number of α and β electrons.

-
-

1.1 Type

+
+

1.1 Type

-
type t 
+
type t 
 
-
-

1.2 Creation

+
+

1.2 Creation

open Common
@@ -358,8 +358,8 @@ Data structure which contains the number of α and β electrons.
 
-
-

1.3 Access

+
+

1.3 Access

val charge       : t -> Charge.t
@@ -408,8 +408,8 @@ Data structure which contains the number of α and β electrons.
 
-
-

1.4 Printers

+
+

1.4 Printers

val pp : Format.formatter -> t -> unit
@@ -418,24 +418,24 @@ Data structure which contains the number of α and β electrons.
 
-
-

1.5 Tests

+
+

1.5 Tests

-
-

2 Element

+
+

2 Element

Chemical elements.

-
-

2.1 Type

+
+

2.1 Type

-
type t =
+
type t =
   |X
   |H                                                 |He
   |Li|Be                              |B |C |N |O |F |Ne
@@ -452,8 +452,8 @@ Chemical elements.
 
-
-

2.2 Conversion

+
+

2.2 Conversion

val of_string      : string -> t
@@ -514,7 +514,7 @@ Chemical elements.
 
 
 
-
+
 Element.of_string "Fe" ;;
 - : Element.t = Particles.Element.Fe
 
@@ -533,8 +533,8 @@ Element.(to_string Fe);;
 
-
-

2.3 Database information

+
+

2.3 Database information

val covalent_radius : t -> Non_negative_float.t
@@ -583,8 +583,8 @@ Element.(to_string Fe);;
 
-
-

2.4 Printers

+
+

2.4 Printers

val pp      : Format.formatter -> t -> unit
@@ -595,30 +595,30 @@ Element.(to_string Fe);;
 
-
-

3 Atomic mass

+
+

3 Atomic mass

Atomic mass, a non-negative float.

-
include module type of Common.Non_negative_float
+
include module type of Common.Non_negative_float
 
-
-

4 Nuclei

+
+

4 Nuclei

-
-

4.1 Type

+
+

4.1 Type

-
open Common
+
open Common
 
 type t = (Element.t * Coordinate.t) array
 
@@ -626,12 +626,12 @@ Atomic mass, a non-negative float.
-
-

4.2 xyz file lexer/parser

+
+

4.2 xyz file lexer/parser

-
-

4.2.1 Lexer

+
+

4.2.1 Lexer

nuclei_lexer.mll contains the description of the lexemes used in @@ -684,8 +684,8 @@ rule read_all = parse

-
-

4.2.2 Parser

+
+

4.2.2 Parser

xyz_parser.mly parses nuclear coordinates in xyz format. @@ -804,8 +804,8 @@ an xyz_file data structure.

-
-

4.3 Conversion

+
+

4.3 Conversion

val of_xyz_string : string -> t
@@ -864,8 +864,8 @@ an xyz_file data structure.
 
-
-

4.4 TODO Query

+
+

4.4 TODO Query

val formula    : t -> string
@@ -914,8 +914,8 @@ an xyz_file data structure.
 
-
-

4.5 Printers

+
+

4.5 Printers

val pp : Format.formatter -> t -> unit
@@ -924,31 +924,31 @@ an xyz_file data structure.
 
-
-

4.6 Tests

+
+

4.6 Tests

-
-

5 Z-matrix

+
+

5 Z-matrix

Z-matrix representation of nuclear coordinates.

-
-

5.1 Type

+
+

5.1 Type

-
type t 
+
type t 
 
-
-

5.2 Conversion

+
+

5.2 Conversion

val of_string      : string -> t
@@ -983,7 +983,7 @@ Z-matrix representation of nuclear coordinates.
 
 
 
-
+
 let zmt = Zmatrix.of_string "
  n
  n    1 nn
@@ -1028,8 +1028,8 @@ H -0.568803 -0.793910 1.726048"
 
-
-

5.3 Printers

+
+

5.3 Printers

val pp : Format.formatter -> t -> unit
@@ -1041,7 +1041,7 @@ H -0.568803 -0.793910 1.726048"
 

Author: Anthony Scemama

-

Created: 2021-01-01 Fri 17:04

+

Created: 2021-01-01 Fri 18:06

Validate

diff --git a/docs/perturbation.html b/docs/perturbation.html index fb2d2be..6f83e50 100644 --- a/docs/perturbation.html +++ b/docs/perturbation.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Perturbation @@ -229,31 +229,31 @@

Table of Contents

-
"Perturbation theory"
+
"Perturbation theory"
 
-
-

1 MP2

+
+

1 MP2

-
-

1.1 Type

+
+

1.1 Type

type t
@@ -262,8 +262,8 @@
 
-
-

1.2 Creation

+
+

1.2 Creation

val make : frozen_core:Mo.Frozen_core.t -> Mo.Basis.t -> t
@@ -286,7 +286,7 @@
 
 
 
-
+
 let mp2 =
   Mp2.make ~frozen_core:(Mo.Frozen_core.(make Small molecule)) mo_basis
   ;;
@@ -295,8 +295,8 @@ let mp2 =
 
-
-

1.3 Access

+
+

1.3 Access

val energy      : t -> float
@@ -331,14 +331,14 @@ let mp2 =
 
 
 
-
+
 
 
-
-

1.4 Printers

+
+

1.4 Printers

val pp : Format.formatter -> t -> unit
@@ -347,14 +347,14 @@ let mp2 =
 
-
-

1.5 Tests

+
+

1.5 Tests

Author: Anthony Scemama

-

Created: 2021-01-01 Fri 17:04

+

Created: 2021-01-01 Fri 17:56

Validate

diff --git a/docs/qcaml.html b/docs/qcaml.html index a62c5be..a0f9e38 100644 --- a/docs/qcaml.html +++ b/docs/qcaml.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + QCaml @@ -226,13 +226,13 @@

QCaml

-
"Main QCaml entry point"
+
"Main QCaml entry point"
 

Author: Anthony Scemama

-

Created: 2021-01-01 Fri 17:04

+

Created: 2021-01-01 Fri 17:56

Validate

diff --git a/docs/simulation.html b/docs/simulation.html index 5b5ce80..112eb57 100644 --- a/docs/simulation.html +++ b/docs/simulation.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Simulation @@ -229,50 +229,50 @@

Table of Contents

-
"Data describing a simulation (AOs, operators, nuclear coordinate,...)"
+
"Data describing a simulation (AOs, operators, nuclear coordinate,...)"
 
-
-

1 Simulation

+
+

1 Simulation

Contains the state of the simulation.

-
open Common
+
open Common
 open Particles
 open Operators
 
-
-

1.1 Type

+
+

1.1 Type

-
type t
+
type t
 
-
-

1.2 Access

+
+

1.2 Access

val nuclei            : t -> Nuclei.t
@@ -327,8 +327,8 @@ Contains the state of the simulation.
 
-
-

1.3 Creation

+
+

1.3 Creation

val make : ?multiplicity:int -> ?charge:int -> 
@@ -348,8 +348,8 @@ Defaults:
 
-
-

1.4 Printers

+
+

1.4 Printers

val pp : Format.formatter -> t -> unit
@@ -361,7 +361,7 @@ Defaults:
 

Author: Anthony Scemama

-

Created: 2021-01-01 Fri 17:04

+

Created: 2021-01-01 Fri 17:56

Validate

diff --git a/docs/top.html b/docs/top.html index a4437ce..a434305 100644 --- a/docs/top.html +++ b/docs/top.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Top-level @@ -226,13 +226,13 @@

Top-level

-
"Installs pretty printers for top-level."
+
"Installs pretty printers for top-level."
 

Author: Anthony Scemama

-

Created: 2021-01-01 Fri 17:04

+

Created: 2021-01-01 Fri 17:56

Validate