Split url attribute into data_url and data_url_history

rayference · Jan 13, 2023 · 955d6d0 · 955d6d0
1 parent 42c53e8
commit 955d6d0
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 21 deletions.
diff --git a/notebooks/coddington_2021.ipynb b/notebooks/coddington_2021.ipynb
@@ -188,10 +188,9 @@
     "            \"title\": f\"{TITLE} ({resolution})\",\n",
     "            \"institution\": INSTITUTION,\n",
     "            \"source\": SOURCE,\n",
-    "            \"reference\": REFERENCES,\n",
-    "            \"raw_data_url\": RAW_DATA_URL\n",
+    "            \"references\": REFERENCES,\n",
     "        }\n",
-    "        ds = tengen.to_dataset(ssi=ssi, w=w, url=RAW_DATA_URL, attrs=_attrs)\n",
+    "        ds = tengen.to_dataset(ssi=ssi, w=w, data_url=RAW_DATA_URL, attrs=_attrs)\n",
     "\n",
     "        if path is not None:\n",
     "            resolution = f\"{res:~}\".replace(\" \", \"_\")\n",

diff --git a/notebooks/coddington_2022.ipynb b/notebooks/coddington_2022.ipynb
@@ -192,10 +192,9 @@
     "            \"title\": f\"{TITLE} ({resolution})\",\n",
     "            \"institution\": INSTITUTION,\n",
     "            \"source\": SOURCE,\n",
-    "            \"reference\": REFERENCES,\n",
-    "            \"raw_data_url\": RAW_DATA_URL\n",
+    "            \"references\": REFERENCES,\n",
     "        }\n",
-    "        ds = tengen.to_dataset(ssi=ssi, w=w, url=RAW_DATA_URL, attrs=_attrs)\n",
+    "        ds = tengen.to_dataset(ssi=ssi, w=w, data_url=RAW_DATA_URL, attrs=_attrs)\n",
     "\n",
     "        if path is not None:\n",
     "            resolution = f\"{res:~}\".replace(\" \", \"_\")\n",

diff --git a/notebooks/meftah_2018.ipynb b/notebooks/meftah_2018.ipynb
@@ -142,12 +142,12 @@
     "    end = datetime.date(2016, 12, 31)\n",
     "    observation_period=\" to \".join(\n",
     "        [x.strftime(\"%Y-%m-%d\") for x in [start, end]]\n",
-    "    ),\n",
+    "    )\n",
     "\n",
     "    ds = tengen.to_dataset(\n",
     "        ssi=ssi,\n",
     "        w=w,\n",
-    "        url=RAW_DATA_URL,\n",
+    "        data_url=RAW_DATA_URL,\n",
     "        attrs={\n",
     "            \"title\": TITLE,\n",
     "            \"institution\": INSTITUTION,\n",
@@ -200,7 +200,7 @@
     "            url=RAW_DATA_URL,\n",
     "            path=tmpdir,\n",
     "        )\n",
-    "        datasets = format_raw_data(\n",
+    "        dataset = format_raw_data(\n",
     "            raw_data=tmpdir,\n",
     "            path=None,\n",
     "        )"

diff --git a/notebooks/solid_2017.ipynb b/notebooks/solid_2017.ipynb
@@ -184,7 +184,7 @@
     "    ds = tengen.to_dataset(\n",
     "        w=w,\n",
     "        ssi=ssi,\n",
-    "        url=RAW_DATA_URL,\n",
+    "        data_url=RAW_DATA_URL,\n",
     "        t=t,\n",
     "        attrs={\n",
     "            \"title\": TITLE,\n",
@@ -238,7 +238,7 @@
     "            url=RAW_DATA_URL,\n",
     "            path=tmpdir,\n",
     "        )\n",
-    "        datasets = format_raw_data(\n",
+    "        dataset = format_raw_data(\n",
     "            raw_data=tmpdir,\n",
     "            path=None,\n",
     "        )"

diff --git a/notebooks/template.ipynb b/notebooks/template.ipynb
@@ -139,7 +139,7 @@
     "            url=RAW_DATA_URL,\n",
     "            path=tmpdir,\n",
     "        )\n",
-    "        datasets = format_raw_data(\n",
+    "        dataset = format_raw_data(\n",
     "            raw_data=tmpdir,\n",
     "            path=None,\n",
     "        )"

diff --git a/notebooks/thuillier_2003.ipynb b/notebooks/thuillier_2003.ipynb
@@ -127,7 +127,7 @@
     "    ds = tengen.to_dataset(\n",
     "        w=w,\n",
     "        ssi=ssi,\n",
-    "        url=RAW_DATA_URL,\n",
+    "        data_url=RAW_DATA_URL,\n",
     "        attrs={\n",
     "            \"Conventions\": \"CF-1.10\",\n",
     "            \"title\": TITLE,\n",
@@ -180,7 +180,7 @@
     "            url=RAW_DATA_URL,\n",
     "            path=tmpdir,\n",
     "        )\n",
-    "        datasets = format_raw_data(\n",
+    "        dataset = format_raw_data(\n",
     "            raw_data=tmpdir,\n",
     "            path=None,\n",
     "        )"

diff --git a/notebooks/whi_2008.ipynb b/notebooks/whi_2008.ipynb
@@ -143,7 +143,7 @@
     "        dataset = tengen.to_dataset(\n",
     "            ssi=data[:, time_period_index] * ureg.W / ureg.m ** 2 / ureg.nm,\n",
     "            w=wavelength * ureg.nm,\n",
-    "            url=RAW_DATA_URL,\n",
+    "            data_url=RAW_DATA_URL,\n",
     "            attrs={\n",
     "                \"title\": TITLE + f\" ({identifier})\",\n",
     "                \"institution\": INSTITUTION,\n",

diff --git a/src/tengen/dataset.py b/src/tengen/dataset.py
@@ -31,7 +31,7 @@
 def to_dataset(
     ssi: pint.Quantity,
     w: pint.Quantity,
-    url: str,
+    data_url: str,
     t: t.Optional[pd.DatetimeIndex] = None,
     attrs: t.Optional[t.Dict[str, str]] = None,
 ) -> xr.Dataset:
@@ -40,7 +40,7 @@ def to_dataset(
     Args:
         ssi: solar spectral irradiance.
         w: radiation wavelength.
-        url: raw data url.
+        data_url: raw data url.
         t: time stamps.
         attrs: dataset attributes.
 
@@ -77,10 +77,11 @@ def to_dataset(
 
     author = f"tengen, version {__version__}"
     _attrs.update(
-        dict(
-            history=f"{utcnow} - data set creation by {author}",
-            url=f"raw data available at {url} (last accessed on {utcnow})",
-        )
+        {
+            "history": f"{utcnow} - data set creation by {author}",
+            "data_url": data_url,
+            "data_url_datetime": utcnow,
+        }
     )
 
     # Create data set