feat: syncs funding organizations and contract numbers to ESS-DIVE

Adds handling for multiple funders and DOE funding contract numbers in dataset_transform function. Splits on new line, comma or semicolon. Edit form: Changes 'description' to 'tooltip' in dataset.json and added placeholders in app.js to support providing more instruction about what funding organizations to enter. Closes #419
NGEET · Mar 29, 2024 · 6290e35 · 6290e35
1 parent eb43849
commit 6290e35
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 30 deletions.
diff --git a/archive_api/service/essdive_transfer/crosswalk.py b/archive_api/service/essdive_transfer/crosswalk.py
@@ -5,6 +5,7 @@
 """
 import csv
 import collections
+import re
 from io import StringIO
 
 from typing import Dict, IO, List, Optional, TextIO, Tuple, Union
@@ -266,6 +267,18 @@ def dataset_transform(dataset) -> Tuple[Dict, Optional[TextIO]]:
     if dataset.qaqc_method_description is not None:
         measurement_technique = dataset.qaqc_method_description and [r for r in dataset.qaqc_method_description .split('\n') if r] or list()
 
+    # --- Funding Organization and Contract Numbers ---
+    funders = [JSONLD_FUNDER]
+    if dataset.funding_organizations:
+        # if there are line breaks, commas, or semicolons, we assume multiple funders
+        for f in re.split('[\n,;]', dataset.funding_organizations):
+            funders.append({"name": f.strip()})
+
+    # --- DOE Funding Contract Numbers --
+    awards = None
+    if dataset.doe_funding_contract_numbers:
+        awards = re.split('[\n,;]', dataset.doe_funding_contract_numbers)
+
     # --- ASSIGN TO JSON-LD ----
 
     json_ld = {
@@ -282,7 +295,8 @@ def dataset_transform(dataset) -> Tuple[Dict, Optional[TextIO]]:
         "variableMeasured": variable_measured,
         "license": JSONLD_LICENSE,
         "spatialCoverage": spatial_coverage,
-        "funder": JSONLD_FUNDER,
+        "funder": funders,
+        "award": awards,
         "temporalCoverage": temporal_coverage,
         "editor": editor,
         "provider": JSONLD_PROVIDER,

diff --git a/archive_api/tests/essdive-transfer.jsonld b/archive_api/tests/essdive-transfer.jsonld
@@ -4,6 +4,7 @@
   "@id": "http://dx.doi.org/10.15486/ngt/1783737",
   "name": "Leaf structural and chemical traits, and BNL field campaign sample details, San Lorenzo, Panama, 2020",
   "alternateName": "NGT0004",
+  "award": ["DE-SC0012704"],
   "citation": [
     "Larson, Kristine & Small, Eric & Gutmann, Ethan & Bilich, Andria & Braun, John & Zavorotny, Valery & Larson, Citation. (2008). Use of GPS receivers as a soil moisture network for water cycle studies. Geophysical Research Letters - GEOPHYS RES LETT. 35. 10.1029/2008GL036013. Solander et al.: The pantropical response of soil moisture to El Niño, Hydrol. Earth Syst. Sci., 24, 2303–2322, https://doi.org/10.5194/hess-24-2303-2020, 2020.",
     "Additional information about citations:",
@@ -56,9 +57,10 @@
       ]
     }
   ],
-  "funder": {
-    "name": "U.S. DOE > Office of Science > Biological and Environmental Research (BER)"
-  },
+  "funder":
+    [{"name": "U.S. DOE > Office of Science > Biological and Environmental Research (BER)"},
+      {"name": "U.S. Department of Energy Office of Science Office of Biological and Environmental Research"}]
+,
   "temporalCoverage": {
     "endDate": "2020-03-13",
     "startDate": "2020-01-14"

diff --git a/archive_api/tests/test_essdive_transfer.py b/archive_api/tests/test_essdive_transfer.py
@@ -283,6 +283,7 @@ def test_dataset_transform(celery_setup, ack_size):
     dataset.acknowledgement += added_ack
 
     jsonld, ack_fp = crosswalk.dataset_transform(dataset)
+    print(jsonld)
 
     if len(dataset.description)+ack_size >= 5000:
         assert ack_fp is not None

diff --git a/ui/static/js/app.js b/ui/static/js/app.js
@@ -236,7 +236,7 @@ $(document).ready(function () {
         }
     });
 
-    $.getJSON("static/js/metadata/dataset.json?v=20240209", function (data) {
+    $.getJSON("static/js/metadata/dataset.json?v=20240329", function (data) {
         templates.datasets = data;
         createEditForm('datasets');
     });
@@ -1715,15 +1715,21 @@ function createEditForm(templateType) {
                 label += '<i class="required">*</i>';
             }
 
-            var tooltip = '<b class="desc-tooltip js-tooltip" title="' + templates[templateType][param].description + '" > ?</b>';
-
+            var tooltip = '<b class="desc-tooltip js-tooltip" title="' + templates[templateType][param].tooltip + '" > ?</b>';
             paramHTML.append($('<span class="js-display-name display-name"></span>').html(label + '&nbsp;&nbsp;' + tooltip));
+
+            if (templates[templateType][param].description) {
+                paramHTML.append($(templates[templateType][param].description));
+            }
             switch (templates[templateType][param].type) {
                 case "string":
                     var tag = $('.js-template' + '.' + templates[templateType][param].type).clone();
                     if (templates[templateType][param].max_length) {
                         tag.attr('maxlength', templates[templateType][param].max_length);
                     }
+                    if(templates[templateType][param].placeholder) {
+                        tag.attr('placeholder', templates[templateType][param].placeholder);
+                    }
                     tag.removeClass('js-template').addClass('js-input');
                     paramHTML.append(tag);
                     break;