mirror of
https://gitlab.com/scemama/QCaml.git
synced 2024-08-16 09:48:30 +02:00
34 lines
837 B
Org Mode
34 lines
837 B
Org Mode
#+TITLE: QCaml documentation
|
|
#+SETUPFILE: ../docs/org-html-themes/org/theme-readtheorg.setup
|
|
|
|
[[./chamo_bg.png]]
|
|
|
|
QCaml is an OCaml library for writing quantum chemistry codes.
|
|
It is written using literate programming with org-mode.
|
|
|
|
To use it interactively in the top level or in a Jupyter or org-mode
|
|
notebook, use
|
|
|
|
#+begin_src ocaml
|
|
#require "qcaml.top" ;;
|
|
#+end_src
|
|
|
|
This loads all the sub-libraries provided with QCaml, and installs
|
|
the pretty printers.
|
|
|
|
* Documentation of Modules
|
|
|
|
#+NAME: modules
|
|
#+begin_src sh :exports none
|
|
ls ../*/README.org \
|
|
| cut -d '/' -f 2
|
|
#+end_src
|
|
|
|
#+NAME: list
|
|
#+begin_src python :var modules=modules :exports results :results output drawer
|
|
for m in modules:
|
|
m = m[0]
|
|
m2 = m.replace("_"," ").capitalize()
|
|
print(f"- [[./{m}.html][{m2}]]")
|
|
#+end_src
|