DOC: Online doc.

MilanSkocic · Mar 25, 2024 · e1018ed · e1018ed
1 parent ff2b5b2
commit e1018ed
Show file tree

Hide file tree

Showing 290 changed files with 39,612 additions and 0 deletions.
diff --git a/docs/0-getting_started/ciaaw.html b/docs/0-getting_started/ciaaw.html
diff --git a/docs/0-getting_started/examples.html b/docs/0-getting_started/examples.html
diff --git a/docs/0-getting_started/index.html b/docs/0-getting_started/index.html
diff --git a/docs/0-getting_started/pyciaaw.html b/docs/0-getting_started/pyciaaw.html
diff --git a/docs/1-user_guide/ciaaw_saw.html b/docs/1-user_guide/ciaaw_saw.html
diff --git a/docs/1-user_guide/index.html b/docs/1-user_guide/index.html
diff --git a/docs/2-releases/0.1.0.html b/docs/2-releases/0.1.0.html
diff --git a/docs/2-releases/0.2.0.html b/docs/2-releases/0.2.0.html
diff --git a/docs/2-releases/index.html b/docs/2-releases/index.html
diff --git a/docs/3-api/ciaaw.html b/docs/3-api/ciaaw.html
diff --git a/docs/3-api/index.html b/docs/3-api/index.html
diff --git a/docs/3-api/pyciaaw.html b/docs/3-api/pyciaaw.html
diff --git a/docs/3-api/raw_data.html b/docs/3-api/raw_data.html
diff --git a/docs/_downloads/a3e9e0886b7059d4c553af028824283a/LICENSE.txt b/docs/_downloads/a3e9e0886b7059d4c553af028824283a/LICENSE.txt
diff --git a/docs/_downloads/aeeecbf1565d1f259d485137e17b99fb/LICENSE.txt b/docs/_downloads/aeeecbf1565d1f259d485137e17b99fb/LICENSE.txt
diff --git a/docs/_downloads/e6f5dfbf76f1058b9f04a4cbae1527f0/ciaaw.pdf b/docs/_downloads/e6f5dfbf76f1058b9f04a4cbae1527f0/ciaaw.pdf
diff --git a/docs/_downloads/ed02f4d818eeb2911ee84b6938430714/refman.pdf b/docs/_downloads/ed02f4d818eeb2911ee84b6938430714/refman.pdf
diff --git a/docs/_images/logo-ciaaw.png b/docs/_images/logo-ciaaw.png
diff --git a/docs/_images/math/618f586c42488286e8a6ac703a98c1e1bd28abf0.png b/docs/_images/math/618f586c42488286e8a6ac703a98c1e1bd28abf0.png
diff --git a/docs/_images/math/621ef381f0388723f759d51e246f34cfdb266318.png b/docs/_images/math/621ef381f0388723f759d51e246f34cfdb266318.png
diff --git a/docs/_images/math/68b272c7a8bfbffd94b8b4d905607eab77bc227b.png b/docs/_images/math/68b272c7a8bfbffd94b8b4d905607eab77bc227b.png
diff --git a/docs/_images/math/6da958c29829cfc5eb83b572bb31f9fdc191cb4e.png b/docs/_images/math/6da958c29829cfc5eb83b572bb31f9fdc191cb4e.png
diff --git a/docs/_sources/0-getting_started/ciaaw.rst.txt b/docs/_sources/0-getting_started/ciaaw.rst.txt
@@ -0,0 +1,25 @@
+ciaaw
+==============
+
+.. image:: ../media/logo-ciaaw.png
+  :width: 200
+  :align: center
+
+.. include:: ../../../../README.rst
+  :start-after: readme_inclusion_start
+  :end-before: readme_inclusion_end
+
+How to install
+^^^^^^^^^^^^^^^^^
+
+.. include:: ../../../../INSTALL.rst
+
+Dependencies
+^^^^^^^^^^^^^^^^^
+
+.. literalinclude:: ../../../../REQUIREMENTS.txt
+
+License
+^^^^^^^^^^^^^^^^^
+
+:download:`GNU General Public License v3 (GPLv3) <../../../../LICENSE.txt>`
diff --git a/docs/_sources/0-getting_started/examples.rst.txt b/docs/_sources/0-getting_started/examples.rst.txt
@@ -0,0 +1,24 @@
+********
+Examples
+********
+
+
+Example in Fortran
+====================
+
+.. literalinclude:: ../../../../example/example_in_f.f90
+    :language: fortran
+
+Example in C
+=============
+
+.. literalinclude:: ../../../../example/example_in_c.c
+    :language: C
+
+
+Example in Python
+==================
+
+.. literalinclude:: ../../../../example/example_in_py.py
+    :language: python
+    :lines: 4-
diff --git a/docs/_sources/0-getting_started/index.rst.txt b/docs/_sources/0-getting_started/index.rst.txt
@@ -0,0 +1,16 @@
+###############
+Getting Started
+###############
+
+.. only:: html
+
+    PDF documentation: :download:`ciaaw <../../build/latex/ciaaw.pdf>`. 
+
+Sources: https://github.com/MilanSkocic/ciaaw
+
+.. toctree::
+    :maxdepth: 1
+
+    ciaaw.rst
+    pyciaaw.rst
+    examples.rst
diff --git a/docs/_sources/0-getting_started/pyciaaw.rst.txt b/docs/_sources/0-getting_started/pyciaaw.rst.txt
@@ -0,0 +1,22 @@
+*******
+pyciaaw
+*******
+
+.. include:: ../../../../pywrapper/README.rst
+  :start-after: readme_inclusion_start
+  :end-before: readme_inclusion_end
+
+How to install
+===============
+
+.. include:: ../../../../pywrapper/INSTALL.rst
+
+Dependencies
+===============
+
+.. literalinclude:: ../../../../pywrapper/requirements.txt
+
+License
+===============
+
+:download:`GNU General Public License v3 (GPLv3) <../../../../pywrapper/LICENSE.txt>`
diff --git a/docs/_sources/1-user_guide/ciaaw_saw.rst.txt b/docs/_sources/1-user_guide/ciaaw_saw.rst.txt
@@ -0,0 +1,18 @@
+***********************
+Standard Atomic Weights
+***********************
+
+The standard atomic weights (or realtive atomic mass), :math:`A_r(E)`, 
+are extracted from table 1 in :cite:t:`prohaska2022-0`. For the elements
+that feature an interval for the standard atomic weight, the mean value and the uncertainty are computed
+using formulas defined in :cite:t:`veen2021-0`:
+
+.. math:: 
+
+    A_r(E) = \frac{a+b}{2}
+
+    u(A_r(E)) = \frac{b-a}{2\sqrt{3}}
+
+The standard atomic weights are a dimensionless quantity and thus they need to be multiplied by 
+the molar mass constant :math:`M_u=0.999 999 999 65 \pm 0.000 000 000 30 g.mol^{-1}` 
+in order to get the value in :math:`g.mol^{-1}`.
diff --git a/docs/_sources/1-user_guide/index.rst.txt b/docs/_sources/1-user_guide/index.rst.txt
@@ -0,0 +1,8 @@
+##########
+User Guide
+##########
+
+.. toctree::
+    :maxdepth: 1
+
+    ciaaw_saw.rst
diff --git a/docs/_sources/2-releases/0.1.0.rst.txt b/docs/_sources/2-releases/0.1.0.rst.txt
@@ -0,0 +1,29 @@
+*****
+0.1.0
+*****
+
+Summary
+=======
+
+* All elements from the periodic table added for the saw module.
+* They are implemented as parameter derived type.
+
+
+Download
+========
+
+`ciaaw <https://github.com/MilanSkocic/ciaaw/releases>`_
+
+`pyciaaw <https://pypi.org/project/pyciaaw>`_
+
+
+Contributors
+============
+
+Milan Skocic
+
+
+Commits
+=======
+
+Full Changelog: https://github.com/MilanSkocic/ciaaw/compare/....0.1.0
diff --git a/docs/_sources/2-releases/0.2.0.rst.txt b/docs/_sources/2-releases/0.2.0.rst.txt
@@ -0,0 +1,30 @@
+*****
+0.2.0
+*****
+
+Summary
+=======
+
+* All elements from the periodic table added for the saw module.
+* They are implemented as parameter derived type.
+* Fix error in phosphorus name.
+
+
+Download
+========
+
+`ciaaw <https://github.com/MilanSkocic/ciaaw/releases>`_
+
+`pyciaaw <https://pypi.org/project/pyciaaw>`_
+
+
+Contributors
+============
+
+Milan Skocic
+
+
+Commits
+=======
+
+Full Changelog: https://github.com/MilanSkocic/ciaaw/compare/0.1.0...0.2.0
diff --git a/docs/_sources/2-releases/index.rst.txt b/docs/_sources/2-releases/index.rst.txt
@@ -0,0 +1,9 @@
+#############
+Release Notes
+#############
+
+.. toctree::
+    :maxdepth: 1
+
+    0.2.0.rst
+    0.1.0.rst
diff --git a/docs/_sources/3-api/ciaaw.rst.txt b/docs/_sources/3-api/ciaaw.rst.txt
@@ -0,0 +1,13 @@
+*****
+ciaaw
+*****
+
+.. only:: html
+
+    `Fortran and C API <../doxygen/index.html>`_ 
+
+    PDF version: :download:`Fortran and C API <../../../doxygen/build/latex/refman.pdf>`. 
+
+.. only:: latex
+
+    `Fortran and C API <https://milanskocic.github.io/ciaaw/3-api/ciaaw.html>`_
diff --git a/docs/_sources/3-api/index.rst.txt b/docs/_sources/3-api/index.rst.txt
@@ -0,0 +1,10 @@
+###
+API
+###
+
+.. toctree::
+    :maxdepth: 1
+
+    ciaaw.rst
+    pyciaaw.rst
+    raw_data.rst
diff --git a/docs/_sources/3-api/pyciaaw.rst.txt b/docs/_sources/3-api/pyciaaw.rst.txt
@@ -0,0 +1,20 @@
+*******
+pyciaaw
+*******
+
+.. automodule:: pyciaaw
+
+SAW (Standard atomic weights)
+===============================
+
+pyciaaw.saw
+===========
+
+.. automodule:: pyciaaw.saw_latest
+    :members:
+
+pyciaaw.saw_2021
+================
+
+.. automodule:: pyciaaw.saw_2021
+    :members:
diff --git a/docs/_sources/3-api/raw_data.rst.txt b/docs/_sources/3-api/raw_data.rst.txt
@@ -0,0 +1,12 @@
+********
+Raw data
+********
+
+Latest
+======
+
+.. literalinclude:: ../../../../srcgen/ciaaw_saw/saw_latest.txt
+
+2018
+====
+.. literalinclude:: ../../../../srcgen/ciaaw_saw/saw_2021.txt
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,21 @@
+#####
+ciaaw
+#####
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   0-getting_started/index.rst
+   1-user_guide/index.rst
+   2-releases/index.rst
+   3-api/index.rst
+   references/index.rst
+
+
+.. only:: html
+
+   Search
+   ==================
+
+   * :ref:`search`
diff --git a/docs/_sources/references/index.rst.txt b/docs/_sources/references/index.rst.txt
@@ -0,0 +1,11 @@
+.. only:: html
+
+    Bibliography
+    =============================
+
+
+    .. toctree::
+        :maxdepth: 2
+
+
+.. bibliography::