Add changelog in README and simplify Fortran documentation.

MilanSkocic · Jan 26, 2025 · 2d6a713 · 2d6a713
1 parent 4b38d61
commit 2d6a713
Show file tree

Hide file tree

Showing 10 changed files with 316 additions and 80 deletions.
diff --git a/README.md b/README.md
@@ -176,3 +176,265 @@ Mohr, P. J., B. N. Taylor, and D. B. Newell. 2021. “CODATA recommended
 values of the fundamental physical constants: 2018.” *Review of Modern
 Physics*, 93.
 
+
+# Changelog
+## 2.1.1
+
+* No code change.
+* Code refractoring and cleaning
+* Update CI/CD workflows.
+
+[Full changelog](https://github.com/MilanSkocic/codata/releases)
+
+
+## 2.1.0
+
+* Roll back to C API in Fortran code: easier maintenance.
+* Roll back to compiled C extension for python: easier maintenance.
+
+Full changelog available at [github](https://github.com/milanskocic/codata/releases)
+
+
+## 2.0.1
+
+* Fix bug in version for Fortran code.
+
+Full changelog available at [github](https://github.com/milanskocic/codata/releases)
+
+
+## 2.0.0
+
+* Drop compiled extensions for Python.
+* Pure Python code for constants auto-generated as it is the case for the Fortran code.
+* Pure C code for constants auto-generated as it is the case for the Fortran code.
+* API break:
+    * No more C API in the Fortran code. 
+    * Use the pure C code to build a C library.
+
+Full changelog available at [github](https://github.com/milanskocic/codata/releases)
+
+## 1.2.2
+
+* Fix conflict that could occur with C API modules. Add prefix in module names.
+* Cleanup and refractoring.
+* Documentation update.
+
+
+## 1.2.1
+
+* Refractoring
+* Merge back C API and python wrapper.
+
+Full changelog available at [github](https://github.com/milanskocic/codata/releases)
+
+
+## 1.2.0
+
+* Refractoring
+* Documentation update.
+
+Full changelog available at [github](https://github.com/milanskocic/codata/releases)
+
+
+## 1.1.0
+
+* C API and Python wrapper moved to their own repositories.
+    * [C wrapper](https://github.com/MilanSkocic/codata-capi)
+    * [Python wrapper](https://github.com/MilanSkocic/codata-py)
+* API break: C API is no more provided by default. Use the optional C wrapper.
+* Code cleanup
+* Documentation update
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+
+## 1.0.0
+
+* Add codata values for 2010, 2014 and 2018.
+* Code refractoring and code cleaning.
+* Documentation update and switch to only FORD documentation.
+* Rewrite code generators in python.
+* Generate source code for stdlib.
+* API break: constants are defined as DT like in stdlib.
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.10.0 
+
+* Remove remove generation of the version module.
+* Add tests using the test-drive framework.
+* Explicit parameter constants for Fortran and protected constants for C API.
+* Minor fixes in documentation.
+* Code cleanup.
+* Merge of all code for autogeneration in one file.
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.9.0
+
+* No API changes.
+* Automatic generation of the version module.
+* Generic Makefiles for automatic the building process of the library and the pywrapper.
+* Add targets: build, build_debug, test, test_debug.
+* Minor fixes in documentation.
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.8.2
+
+* No API changes.
+* Improve Makefile for generating the source code at each compilation.
+* Source generator rewritten in Fortran. 
+* Switch to pyproject.toml for the Python wrapper.
+* Minor fixes in documentation.
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.8.1
+
+* Use shared library in python wrapper.
+* Minor fixes in documentation.
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.8.0
+
+* Back to the approach with a library.
+* Compatible with fpm.
+* Configuration file for setting all the environmental variables.
+* Global makefile for building a static library (through fpm) and a shared library.
+* Automatic copy of the necessary sources for the python wrapper.
+* Python wrapper built with the static library
+   * no dependency on a shared library.
+   * sources and static library embeded in the python wrapper.
+* FORD for documenting the Fortran code.
+* Integration of the FORD documentation into the main documentation with sphinx.
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.7.1
+
+* Minor fixes in generator code
+* Add automatic copy of c sources for the python wrapper.
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.7.0
+
+* Migrate documentation from doxygen to sphinx+breathe.
+* Add YEAR constant indicating the year of the codata constants.
+* Refractoring
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.6.0
+
+* Created documentation.
+* Fixed missing uncertainties for Cpython.
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.5.0
+
+* Changed the complete approach by not generating a library but only source files for different languages.
+* Available languages: Fortran, C, python, CPython
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.4.0
+
+* Bring back pywrapper in the codata repository to sync versions.
+* Improvements of the documentation.
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.3.0
+
+* Only last codata constants. 
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.2.1
+
+* Integration of Intel Fortran compiler and MSVC in cmake scripts.
+* Add specifications and instructions for compiling on Windows 
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.2.0
+
+* Bug fixes for the codata 2010.
+* Bug fixes in the tests linked to the codata 2010.
+* Add python wrapper for the number of constants method. 
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
+
+
+## 0.1.0
+
+Implementation of:
+
+* the parser of the codata raw data
+* the generator of the Fortran modules
+* the C API and C header
+* the python wrapper (will be moved to its repository next release).
+
+Full changelog available at [github](https://github.com/MilanSkocic/codata/releases)
+
+Python wrapper available at [pypi](https://pypi.org/project/pycodata).
+
diff --git a/doc/changelog.md b/doc/changelog.md
diff --git a/doc/examples.md b/doc/examples.md
diff --git a/doc/index.md b/doc/index.md
@@ -1,7 +1,51 @@
 ---
-title: Contributing and specs
+title: APIs
 ---
 
 ![Codata](../media/logo.png)
 
 Fundamental physical constants for Modern Fortran.
+
+# Fortran API
+
+The modules: 
+
+* [[codata__constants_2022(module)]] 
+* [[codata__constants_2018(module)]] 
+* [[codata__constants_2014(module)]] 
+* [[codata__constants_2010(module)]] 
+
+are automatically generated with a simple parser written in Python.
+
+The latest codata constants were released in 2022 by the [NIST](http://physics.nist.gov/constants).
+All values for the codata constants are provided as double precision reals in a derived type
+[[codata__constants_type(module):codata_constant_type(type)]].
+The names are quite long and can be aliased with shorter names.
+A module level interface [[codata__constants_type(module):to_real(interface)]] is 
+available for getting the constant value or uncertainty of a constant. 
+
+```fortran
+{!example/example.f90!}
+```
+
+# C API
+
+The prototypes of the C API are defined as shown below.
+
+```c
+{!include/codata.h!}
+
+```
+
+```C
+{!example/example.c!}
+```
+
+# Python wrapper
+
+The latest values are available at the top level and the 
+older values are available in dedicated modules.
+
+```python
+{!example/example.py!}
+```
diff --git a/doc/license.md b/doc/license.md
diff --git a/doc/references.md b/doc/references.md
diff --git a/doc/specs/api.md b/doc/specs/api.md
diff --git a/doc/specs/capi.md b/doc/specs/capi.md