updated manual and readme

tgasser · Jun 3, 2021 · 767ab38 · 767ab38
1 parent 39a1de7
commit 767ab38
Show file tree

Hide file tree

Showing 15 changed files with 20 additions and 15 deletions.
diff --git a/MANUAL.md b/MANUAL.md
@@ -1,4 +1,4 @@
-# OSCAR v3.1.1
+# OSCAR v3.1.2
 _Manual_ 
 
 
@@ -264,7 +264,7 @@ Each of the model's variable is defined through a `Process` object; and a `Model
 | `d_OHC` | <img src="https://latex.codecogs.com/gif.latex?\textstyle{\frac{\mathrm{d}}{\mathrm{d}t}}\mathrm{OHC}" /> | ZJ yr<sup>-1</sup> | - ||
 ||||||
 | `D_pH` | - | 1 | - ||
-&#8224; Default; can be altered through the `fct_process_alt` functions.
+&#8224; default; can be altered through the `fct_process_alt` functions.
 
 ### Parameters
 

diff --git a/MANUAL.pdf b/MANUAL.pdf
diff --git a/README.md b/README.md
@@ -6,13 +6,18 @@ A compact Earth system model.
 
 Download a release. *Read The Fine [Manual](./MANUAL.md).*
 
-OSCAR v3 is developed in Python 3.7 and run preferentially through IPython. It makes heavy use of the `xarray` package (v0.14.1), and `netCDF4` for saving data (v1.4.2). It also relies on other common scientific packages: `numpy` (v1.16.5) and `scipy` (v1.3.1). Although the latest versions of the packages used to run OSCAR v3 are given, older versions are likely to work.
+OSCAR v3 is developed in Python 3.7 and run preferentially through IPython. It makes heavy use of the `xarray` package (v0.16.0), and `netCDF4` for saving data (v1.5.3). It also relies on other common scientific packages: `numpy` (v1.19.2) and `scipy` (v1.5.2). Although the latest versions of the packages used to run OSCAR v3 are given, older versions are likely to work.
 
-The source code is provided firstly for transparency, and only secondly for dissemination. This means that it is provided as is, and no support of any kind is guaranteed (but feel free to ask). Feedbacks and contributions are always welcome.
+The source code is provided firstly for transparency, and only secondly for dissemination. This means that it is provided as is, and no support of any kind is guaranteed (but feel free to ask). Feedbacks and contributions are welcome.
 
 
 ## Changelog
 
+###### v3.1.2
+* Added: finest possible regional aggregation, given that the parameters are still calibrated following the v2 approach.
+* Added: an additional option for the structure of the bookkeping module, in which the effect of land cover change and management are separated. This is added in a temporary file that will be merged with `fct_process_alt` in the next version.
+* Fixed: the definition of `Houghton_2017` regions that had Colombia and Guinea swapped. This had minimal impact on the land C cycle.
+
 ###### v3.1.1
 This version is exactly the one used in the IPCC AR6. A number of functionalities were added, mostly for convenience.
 * WARNING: `fct_process` was renamed `mod_process` for consistency, which may affect existing run scripts.

diff --git a/README.pdf b/README.pdf
diff --git a/core_fct/cls_main.py b/core_fct/cls_main.py
@@ -1,5 +1,5 @@
 """
-Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2020; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2014-2016
+Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2021; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2014-2016
 Contributor(s): Thomas Gasser ([email protected]), Yann Quilcaille
 
 This software is a computer program whose purpose is to simulate the behavior of the Earth system, with a specific but not exclusive focus on anthropogenic climate change.

diff --git a/core_fct/fct_calib.py b/core_fct/fct_calib.py
@@ -1,5 +1,5 @@
 """
-Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2020; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
+Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2021; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
 Contributor(s): Thomas Gasser ([email protected]), Yann Quilcaille
 
 This software is a computer program whose purpose is to simulate the behavior of the Earth system, with a specific but not exclusive focus on anthropogenic climate change.

diff --git a/core_fct/fct_genD.py b/core_fct/fct_genD.py
@@ -1,5 +1,5 @@
 """
-Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2020; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
+Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2021; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
 Contributor(s): Thomas Gasser ([email protected]), Yann Quilcaille
 
 This software is a computer program whose purpose is to simulate the behavior of the Earth system, with a specific but not exclusive focus on anthropogenic climate change.

diff --git a/core_fct/fct_genMC.py b/core_fct/fct_genMC.py
@@ -1,5 +1,5 @@
 """
-Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2020; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
+Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2021; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
 Contributor(s): Thomas Gasser ([email protected]), Yann Quilcaille
 
 This software is a computer program whose purpose is to simulate the behavior of the Earth system, with a specific but not exclusive focus on anthropogenic climate change.

diff --git a/core_fct/fct_loadD.py b/core_fct/fct_loadD.py
@@ -1,5 +1,5 @@
 """
-Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2020; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
+Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2021; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
 Contributor(s): Thomas Gasser ([email protected]), Yann Quilcaille
 
 This software is a computer program whose purpose is to simulate the behavior of the Earth system, with a specific but not exclusive focus on anthropogenic climate change.

diff --git a/core_fct/fct_loadP.py b/core_fct/fct_loadP.py
@@ -1,5 +1,5 @@
 """
-Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2020; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
+Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2021; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
 Contributor(s): Thomas Gasser ([email protected]), Yann Quilcaille
 
 This software is a computer program whose purpose is to simulate the behavior of the Earth system, with a specific but not exclusive focus on anthropogenic climate change.

diff --git a/core_fct/fct_misc.py b/core_fct/fct_misc.py
@@ -1,5 +1,5 @@
 """
-Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2020; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
+Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2021; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
 Contributor(s): Thomas Gasser ([email protected]), Yann Quilcaille
 
 This software is a computer program whose purpose is to simulate the behavior of the Earth system, with a specific but not exclusive focus on anthropogenic climate change.

diff --git a/core_fct/fct_process_alt.py b/core_fct/fct_process_alt.py
@@ -1,5 +1,5 @@
 """
-Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2020; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2014-2016
+Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2021; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2014-2016
 Contributor(s): Thomas Gasser ([email protected]), Yann Quilcaille
 
 This software is a computer program whose purpose is to simulate the behavior of the Earth system, with a specific but not exclusive focus on anthropogenic climate change.

diff --git a/core_fct/fct_process_tmp.py b/core_fct/fct_process_tmp.py
@@ -1,5 +1,5 @@
 """
-Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2020; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2014-2016
+Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2021; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2014-2016
 Contributor(s): Thomas Gasser ([email protected]), Yann Quilcaille
 
 This software is a computer program whose purpose is to simulate the behavior of the Earth system, with a specific but not exclusive focus on anthropogenic climate change.

diff --git a/core_fct/fct_wrap.py b/core_fct/fct_wrap.py
@@ -1,5 +1,5 @@
 """
-Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2020; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
+Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2021; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2016
 Contributor(s): Thomas Gasser ([email protected]), Yann Quilcaille
 
 This software is a computer program whose purpose is to simulate the behavior of the Earth system, with a specific but not exclusive focus on anthropogenic climate change.

diff --git a/core_fct/mod_process.py b/core_fct/mod_process.py
@@ -1,5 +1,5 @@
 """
-Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2020; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2014-2016
+Copyright: IIASA (International Institute for Applied Systems Analysis), 2016-2021; CEA (Commissariat a L'Energie Atomique) & UVSQ (Universite de Versailles et Saint-Quentin), 2014-2016
 Contributor(s): Thomas Gasser ([email protected]), Yann Quilcaille
 
 This software is a computer program whose purpose is to simulate the behavior of the Earth system, with a specific but not exclusive focus on anthropogenic climate change.