Merge pull request #82 from znichollscr/add-abrupt-experiments

Add abrupt* experiments

Author: ltroussellier

activity/cfmip.json

@@ -1,10 +1,7 @@
 {
     "@context": "000_context.jsonld",
-    "type": "activity",
     "id": "cfmip",
-    "name": "CFMIP",
-    "cmip_acronym": "CFMIP",
-    "long_name": "Cloud Feedback Model Intercomparison Project",
-    "url": null,
+    "type": "activity",
+    "description": "Cloud feedback model intercomparison project. Focussed primarily on cloud feedbacks with a secondary focus on understanding of response to forcing, model biases, circulation, regional-scale precipitation, and non-linear changes.",
     "drs_name": "CFMIP"
-}
+}

experiment/abrupt-0p5xco2.json

@@ -2,32 +2,22 @@
     "@context": "000_context.jsonld",
     "id": "abrupt-0p5xco2",
     "type": "experiment",
-    "experiment_id": "abrupt-0p5xCO2",
-    "activity_id": [
-        "cfmip"
-    ],
+    "description": "Abrupt halving of atmospheric carbon dioxide levels. All other conditions are kept the same as piControl.",
+    "drs_name": "abrupt-0p5xCO2",
+    "start_timestamp": null,
+    "end_timestamp": null,
+    "activity": "cfmip",
     "additional_allowed_model_components": [
         "aer",
         "chem",
         "bgc"
     ],
-    "description": "Identical to the DECK abrupt-4xCO2, but at 0.5xCO2",
-    "end_year": null,
-    "experiment": "abrupt halving of CO2",
-    "min_number_yrs_per_sim": "150",
-    "parent_activity_id": [
-        "cmip"
-    ],
-    "parent_experiment_id": [
-        "picontrol"
-    ],
+    "branch_information": "Branch from `piControl` at a time of your choosing",
+    "min_ensemble_size": 1,
+    "parent_activity": "cmip",
+    "parent_experiment": "picontrol",
     "required_model_components": [
         "aogcm"
     ],
-    "start_year": null,
-    "sub_experiment_id": [
-        "none"
-    ],
-    "tier": "2",
-    "drs_name": "abrupt-0p5xCO2"
-}
+    "tier": 1
+}

experiment/abrupt-2xco2.json

@@ -2,32 +2,22 @@
     "@context": "000_context.jsonld",
     "id": "abrupt-2xco2",
     "type": "experiment",
-    "experiment_id": "abrupt-2xCO2",
-    "activity_id": [
-        "cfmip"
-    ],
+    "description": "Abrupt doubling of atmospheric carbon dioxide levels. All other conditions are kept the same as piControl.",
+    "drs_name": "abrupt-2xCO2",
+    "start_timestamp": null,
+    "end_timestamp": null,
+    "activity": "cfmip",
     "additional_allowed_model_components": [
         "aer",
         "chem",
         "bgc"
     ],
-    "description": "Identical to the DECK abrupt-4xCO2, but at 2xCO2",
-    "end_year": null,
-    "experiment": "abrupt doubling of CO2",
-    "min_number_yrs_per_sim": "150",
-    "parent_activity_id": [
-        "cmip"
-    ],
-    "parent_experiment_id": [
-        "picontrol"
-    ],
+    "branch_information": "Branch from `piControl` at a time of your choosing",
+    "min_ensemble_size": 1,
+    "parent_activity": "cmip",
+    "parent_experiment": "picontrol",
     "required_model_components": [
         "aogcm"
     ],
-    "start_year": null,
-    "sub_experiment_id": [
-        "none"
-    ],
-    "tier": "2",
-    "drs_name": "abrupt-2xCO2"
-}
+    "tier": 1
+}

experiment/abrupt-4xco2.json

@@ -2,32 +2,22 @@
     "@context": "000_context.jsonld",
     "id": "abrupt-4xco2",
     "type": "experiment",
-    "experiment_id": "abrupt-4xCO2",
-    "activity_id": [
-        "cmip"
-    ],
+    "description": "Abrupt quadrupling of atmospheric carbon dioxide levels. All other conditions are kept the same as piControl.",
+    "drs_name": "abrupt-4xCO2",
+    "start_timestamp": null,
+    "end_timestamp": null,
+    "activity": "cmip",
     "additional_allowed_model_components": [
         "aer",
         "chem",
         "bgc"
     ],
-    "description": "DECK: abrupt-4xCO2",
-    "end_year": null,
-    "experiment": "abrupt quadrupling of CO2",
-    "min_number_yrs_per_sim": 150,
-    "parent_activity_id": [
-        "cmip"
-    ],
-    "parent_experiment_id": [
-        "picontrol"
-    ],
+    "branch_information": "Branch from `piControl` at a time of your choosing",
+    "min_ensemble_size": 1,
+    "parent_activity": "cmip",
+    "parent_experiment": "picontrol",
     "required_model_components": [
         "aogcm"
     ],
-    "start_year": null,
-    "sub_experiment_id": [
-        "none"
-    ],
-    "tier": 1,
-    "drs_name": "abrupt-4xCO2"
-}
+    "tier": 1
+}

scripts/generate-experiments.py

@@ -170,6 +170,11 @@ def initialise_activities(self) -> "Holder":
                     "https://doi.org/10.5194/gmd-9-2853-2016",
                 ],
             ),
+            ActivityProject(
+                id="cfmip",
+                experiments=[],
+                urls=["https://doi.org/10.5194/gmd-10-359-2017"],
+            ),
             ActivityProject(
                 id="cmip",
                 experiments=[],
@@ -267,6 +272,60 @@ def add_1pctco2_entries(self) -> "Holder":
 
         return self
 
+    def add_abruptco2_entries(self) -> "Holder":
+        for drs_name, description_start, activity in (
+            (
+                "abrupt-4xCO2",
+                "Abrupt quadrupling of atmospheric carbon dioxide levels.",
+                "cmip",
+            ),
+            (
+                "abrupt-2xCO2",
+                "Abrupt doubling of atmospheric carbon dioxide levels.",
+                "cfmip",
+            ),
+            (
+                "abrupt-0p5xCO2",
+                "Abrupt halving of atmospheric carbon dioxide levels.",
+                "cfmip",
+            ),
+        ):
+            univ = ExperimentUniverse(
+                drs_name=drs_name,
+                description=(
+                    f"{description_start} All other conditions are kept the same as piControl."
+                ),
+                activity=activity,
+                additional_allowed_model_components=["aer", "chem", "bgc"],
+                branch_information="Branch from `piControl` at a time of your choosing",
+                end_timestamp=None,
+                min_ensemble_size=1,
+                # Defined in project
+                min_number_yrs_per_sim="dont_write",
+                parent_activity="cmip",
+                parent_experiment="picontrol",
+                # Defined in project
+                parent_mip_era="dont_write",
+                required_model_components=["aogcm"],
+                start_timestamp=None,
+                tier=1,
+            )
+
+            self.experiments_universe.append(univ)
+
+            proj = ExperimentProject(
+                id=univ.drs_name.lower(),
+                activity=univ.activity,
+                min_number_yrs_per_sim=300,
+                parent_mip_era="cmip7",
+                tier=1,
+            )
+            self.experiments_project.append(proj)
+
+            self.add_experiment_to_activity(proj)
+
+        return self
+
     def write_files(self, project_root: Path, universe_root: Path) -> None:
         for experiment_project in self.experiments_project:
             experiment_project.write_file(project_root)
@@ -324,6 +383,7 @@ def main():
     holder.initialise_activities()
 
     holder.add_1pctco2_entries()
+    holder.add_abruptco2_entries()
 
     holder.write_files(project_root=project_root, universe_root=universe_root)