Merge branch 'main' of https://github.com/MilanSkocic/codata

MilanSkocic · Dec 10, 2024 · d8388b7 · d8388b7
2 parents 154125f + ca72883
commit d8388b7
Show file tree

Hide file tree

Showing 57 changed files with 471 additions and 169 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -3,12 +3,5 @@
 
 doc/** linguist-documentation
 docs/** linguist-documentation
-example/** linguist-vendored
-include/** linguist-vendored
-capi/** linguist-vendored
 media/** linguist-vendored
-pywrapper/** linguist-vendored
-py/** linguist-vendored
-C/** linguist-vendored
 scripts/** linguist-vendored
-
diff --git a/C/README.md b/C/README.md
@@ -1,7 +1,8 @@
+
 # Introduction
 
-`codata` is a C library providing the latest codata constants (2022) and 
-older values (2018, 2014 and 2010). 
+`codata` is a C library providing the latest codata constants (2022) and
+older values (2018, 2014 and 2010).
 The raw codata are taken from http://physics.nist.gov/constants.
 The constants (values and uncertainties) are implemented as double precision reals.
 
@@ -15,34 +16,55 @@ gcc>=10
 
 # Installation
 
-A Makefile is provided, which uses [fpm](https://fpm.fortran-lang.org), for building the library.
+A Makefile is provided for building the library.
 
-* On windows, [msys2](https://www.msys2.org) needs to be installed. 
-  Add the msys2 binary (usually C:\\msys64\\usr\\bin) to the path in order to be able to use make.
+* On windows, [msys2](https://www.msys2.org) needs to be installed.
+Add the msys2 binary (usually C:\msys64\usr\bin) to the path in order to be able to use make.
 * On Darwin, the [gcc](https://formulae.brew.sh/formula/gcc) toolchain needs to be installed.
 
 Build: the configuration file will set all the environment variables necessary for the compilation
 
 ```
-    . ../configure.sh
-    make
+cd ..
+. configure.sh
+cd C
+make
+make install
+make uninstall
 ```
 
 
-Install
+# License
 
-```
-    make install
-```
+MIT
 
-Uninstall
 
-```
-    make uninstall
-```
+# Usage
 
 
+```C
+#include <stdio.h>
+#include "codata.h"
 
-# License
+int main(void){
 
-MIT
+printf("########## EXAMPLE IN C ##########n");
+
+printf("%sn","########## VERSION ##########");
+printf("version = %sn", version);
+
+printf("%sn","########## CONSTANTS ##########");
+printf("c = %fn", SPEED_OF_LIGHT_IN_VACUUM.value);
+
+printf("%sn","########## UNCERTAINTY ##########");
+printf("u(c) = %fn", SPEED_OF_LIGHT_IN_VACUUM.uncertainty);
+
+printf("%sn","########## OLDER VALUES ##########");
+printf("Mu_2022(latest) = %23.16fn", MOLAR_MASS_CONSTANT.value);
+printf("Mu_2018 = %23.16fn", MOLAR_MASS_CONSTANT_2018.value);
+printf("Mu_2014 = %23.16fn", MOLAR_MASS_CONSTANT_2014.value);
+printf("Mu_2010 = %23.16fn", MOLAR_MASS_CONSTANT_2010.value);
+
+return 0;
+}
+```
diff --git a/C/README_TEMPLATE.txt b/C/README_TEMPLATE.txt
@@ -0,0 +1,43 @@
+# Introduction
+
+`codata` is a C library providing the latest codata constants (2022) and 
+older values (2018, 2014 and 2010). 
+The raw codata are taken from http://physics.nist.gov/constants.
+The constants (values and uncertainties) are implemented as double precision reals.
+
+
+# Dependencies
+
+```
+gcc>=10
+```
+
+
+# Installation
+
+A Makefile is provided for building the library.
+
+* On windows, [msys2](https://www.msys2.org) needs to be installed. 
+  Add the msys2 binary (usually C:\\msys64\\usr\\bin) to the path in order to be able to use make.
+* On Darwin, the [gcc](https://formulae.brew.sh/formula/gcc) toolchain needs to be installed.
+
+Build: the configuration file will set all the environment variables necessary for the compilation
+
+```
+    cd ..
+    . configure.sh
+    cd C
+    make
+    make install
+    make uninstall
+```
+
+
+# License
+
+MIT
+
+
+# Usage
+
+
diff --git a/C/VERSION b/C/VERSION
@@ -1 +1 @@
-2.0.0
+2.0.1
diff --git a/C/include/codata.h b/C/include/codata.h
@@ -6,9 +6,5 @@
 #define ADD_IMPORT
 #endif
 #include "codata_version.h"
-#include "codata_constants_type.h"
-#include "codata_constants_2010.h"
-#include "codata_constants_2014.h"
-#include "codata_constants_2018.h"
-#include "codata_constants_2022.h"
+#include "codata_constants.h"
 #endif
diff --git a/C/include/codata_constants.h b/C/include/codata_constants.h
@@ -0,0 +1,13 @@
+#ifndef CODATA_CONSTANTS_H
+#define CODATA_CONSTANTS_H
+#if _MSC_VER
+#define ADD_IMPORT __declspec(dllimport)
+#else
+#define ADD_IMPORT
+#endif
+#include "codata_constants_type.h"
+#include "codata_constants_2010.h"
+#include "codata_constants_2014.h"
+#include "codata_constants_2018.h"
+#include "codata_constants_2022.h"
+#endif
diff --git a/C/src/codata_version.c b/C/src/codata_version.c
@@ -1,2 +1,2 @@
 #include "codata_version.h"
-const char version[32] = "2.0.0";
+const char version[32] = "2.0.1";
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+# 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.

diff --git a/README.md b/README.md
@@ -1,30 +1,40 @@
+
 # Introduction
 
-`codata` is a Fortran library providing the latest codata constants (2022) and 
-older values (2018, 2014 and 2010). 
-The raw codata are taken from http://physics.nist.gov/constants.
-The constants (values and uncertainties) are implemented as double precision reals.
+`codata` is a Fortran library providing the latest codata constants (2022) and
+older values (2018, 2014 and 2010).
+The constants (values and uncertainties) are implemented as double precision reals
+in derived types.
+The sources are automatically generated from the raw codata values taken 
+from http://physics.nist.gov/constants.
 
 The names are quite long and can be aliased with shorter names.
 
 To use `codata` within your [fpm](https://github.com/fortran-lang/fpm) project,
 add the following to your `fpm.toml` file:
 
 ```
-    [dependencies]
-    codata = { git="https://github.com/MilanSkocic/codata.git" }
+[dependencies]
+codata = { git="https://github.com/MilanSkocic/codata.git" }
 ```
 
-**Notes**: 
+**Important**:
+
+* The latest codata constants were integrated in the [stdlib](https://github.com/fortran-lang/stdlib/releases/tag/v0.7.0).
+  The constants are implemented as derived type which carries the name, the value, the uncertainty and the unit.
+  This library will be complementary to the constants defined in the stdlib by providing older values for the constants.
 
-* The latest codata constants were integrated in the [stdlib](https://github.com/fortran-lang/stdlib/releases/tag/v0.7.0). The constants are implemented as derived type which carries the name, the value, the uncertainty and the unit. This library will be complementary to the constants defined in the stdlib by providing older values for the constants. 
+* If you only need sources for the codata constants that you can integrate directly in your sources you may be interested by https://github.com/vmagnin/fundamental_constants.
 
-* If you only need sources for the codata constants that you can integrate directly in your sources you may be interested by https://github.com/vmagnin/fundamental_constants. 
+**Extra: C and Python**
 
-**Extra:**
+`codata` is primarily a Fortran library but sources for C and Python are also
+generated:
 
 * Pure python code is provided in the `py` folder. See `py/README.md`.
+  A python package is available [pypi](https://pypi.org/project/pycodata).
 * Pure C code is provided in the `C` folder. See `C/README.md`
+  A Makefile is provided for building the C library.
 
 
 # Dependencies
@@ -41,39 +51,52 @@ fypp>=3.0
 
 A Makefile is provided, which uses [fpm](https://fpm.fortran-lang.org), for building the library.
 
-* On windows, [msys2](https://www.msys2.org) needs to be installed. 
-  Add the msys2 binary (usually C:\\msys64\\usr\\bin) to the path in order to be able to use make.
+* On windows, [msys2](https://www.msys2.org) needs to be installed.
+Add the msys2 binary (usually C:\msys64\usr\bin) to the path in order to be able to use make.
 * On Darwin, the [gcc](https://formulae.brew.sh/formula/gcc) toolchain needs to be installed.
 
 Build: the configuration file will set all the environment variables necessary for the compilation
 
 ```
-    chmod +x configure.sh
-    . ./configure.sh
-    make
+chmod +x configure.sh
+. ./configure.sh
+make
+make install
+make uninstall
 ```
 
-Run tests
 
-```
-    make test
-```
+# License
 
+MIT
 
-Install
 
-```
-    make install
-```
+# Usage
 
-Uninstall
 
-```
-    make uninstall
-```
+```Fortran
+program example_in_f
+use iso_fortran_env
+use codata
+implicit none
 
+print '(A)', '########## EXAMPLE IN FORTRAN ##########'
 
+print '(A)', '########## VERSION ##########'
+print *, "version = ", version
 
-# License
+print '(A)', '########## CONSTANTS ##########'
+print *, "c = ", SPEED_OF_LIGHT_IN_VACUUM%value
 
-MIT
+print '(A)', '########## UNCERTAINTY ##########'
+print *, "u(c) = ", SPEED_OF_LIGHT_IN_VACUUM%uncertainty
+
+print '(A)', '########## OLDER VALUES ##########'
+print '(A, F23.16)', "Mu_2022(latest) = ", MOLAR_MASS_CONSTANT%value
+print '(A, F23.16)', "Mu_2018 = ", MOLAR_MASS_CONSTANT_2018%value
+print '(A, F23.16)', "Mu_2014 = ", MOLAR_MASS_CONSTANT_2014%value
+print '(A, F23.16)', "Mu_2010 = ", MOLAR_MASS_CONSTANT_2010%value
+
+
+end program
+```
diff --git a/README_TEMPLATE.txt b/README_TEMPLATE.txt
@@ -0,0 +1,66 @@
+# Introduction
+
+`codata` is a Fortran library providing the latest codata constants (2022) and 
+older values (2018, 2014 and 2010). 
+The raw codata are taken from http://physics.nist.gov/constants.
+The constants (values and uncertainties) are implemented as double precision reals.
+
+The names are quite long and can be aliased with shorter names.
+
+To use `codata` within your [fpm](https://github.com/fortran-lang/fpm) project,
+add the following to your `fpm.toml` file:
+
+```
+    [dependencies]
+    codata = { git="https://github.com/MilanSkocic/codata.git" }
+```
+
+**Notes**: 
+
+* The latest codata constants were integrated in the [stdlib](https://github.com/fortran-lang/stdlib/releases/tag/v0.7.0). The constants are implemented as derived type which carries the name, the value, the uncertainty and the unit. This library will be complementary to the constants defined in the stdlib by providing older values for the constants. 
+
+* If you only need sources for the codata constants that you can integrate directly in your sources you may be interested by https://github.com/vmagnin/fundamental_constants. 
+
+**Extra:**
+
+* Pure python code is provided in the `py` folder. See `py/README.md`.
+* Pure C code is provided in the `C` folder. See `C/README.md`
+
+
+# Dependencies
+
+```
+gfortran>=10
+fpm>=0.7
+stdlib>=0.5
+fypp>=3.0
+```
+
+
+# Installation
+
+A Makefile is provided, which uses [fpm](https://fpm.fortran-lang.org), for building the library.
+
+* On windows, [msys2](https://www.msys2.org) needs to be installed. 
+  Add the msys2 binary (usually C:\\msys64\\usr\\bin) to the path in order to be able to use make.
+* On Darwin, the [gcc](https://formulae.brew.sh/formula/gcc) toolchain needs to be installed.
+
+Build: the configuration file will set all the environment variables necessary for the compilation
+
+```
+    chmod +x configure.sh
+    . ./configure.sh
+    make
+    make install
+    make uninstall
+```
+
+
+# License
+
+MIT
+
+
+# Usage
+
+
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.0.0
+2.0.1