Merge pull request #127 from scipp/scicat-links

Show links to SciCat datasets
scipp · Jan 30, 2025 · 94eca18 · 94eca18
2 parents 34f4996 + 0596b82
commit 94eca18
Showing 1 changed file with 35 additions and 0 deletions.
diff --git a/src/ess/dream/data.py b/src/ess/dream/data.py
@@ -49,6 +49,11 @@ def get_path(name: str, unzip: bool = False) -> str:
 def simulated_diamond_sample() -> str:
     """Path to a GEANT4 CSV file for a diamond sample.
 
+    SciCat:
+
+    - PID: ``20.500.12269/d17b7169-b963-4b23-9455-d7332b992184``
+    - URL: https://staging.scicat.ess.eu/datasets/20.500.12269%2Fd17b7169-b963-4b23-9455-d7332b992184
+
     **Sample**:
 
     - Diamond powder
@@ -79,6 +84,11 @@ def simulated_diamond_sample() -> str:
 def simulated_vanadium_sample() -> str:
     """Path to a GEANT4 CSV file for a vanadium sample.
 
+    SciCat:
+
+    - PID: ``20.500.12269/9e43a311-dc17-4f0e-a4d4-2341186b5512``
+    - URL: https://staging.scicat.ess.eu/datasets/20.500.12269%2F9e43a311-dc17-4f0e-a4d4-2341186b5512
+
     Contains both coherent and incoherent scattering.
 
     **Sample**:
@@ -97,6 +107,11 @@ def simulated_vanadium_sample() -> str:
 def simulated_vanadium_sample_incoherent() -> str:
     """Path to a GEANT4 CSV file for a vanadium sample with only incoherent scattering.
 
+    SciCat:
+
+    - PID: ``20.500.12269/b170848e-455e-4c43-8666-68e20f922326``
+    - URL: https://staging.scicat.ess.eu/datasets/20.500.12269%2Fb170848e-455e-4c43-8666-68e20f922326
+
     **Sample**:
 
     - outer radius of sample in (x,z) plane=0.006 m
@@ -109,6 +124,11 @@ def simulated_vanadium_sample_incoherent() -> str:
 def simulated_empty_can() -> str:
     """Path to a GEANT4 CSV file for an empty can measurement.
 
+    SciCat:
+
+    - PID: ``20.500.12269/1a280698-aa5a-4cfb-bc4f-68fcd40462cc``
+    - URL: https://staging.scicat.ess.eu/datasets/20.500.12269%2F1a280698-aa5a-4cfb-bc4f-68fcd40462cc
+
     **Container**:
 
     - radius=0.006 m
@@ -127,6 +147,11 @@ def simulated_empty_can() -> str:
 def simulated_monitor_diamond_sample() -> str:
     """Path to a Mcstas file for a monitor for the diamond measurement.
 
+    SciCat:
+
+    - PID: ``20.500.12269/d17b7169-b963-4b23-9455-d7332b992184``
+    - URL: https://staging.scicat.ess.eu/datasets/20.500.12269%2Fd17b7169-b963-4b23-9455-d7332b992184
+
     This is the DREAM cave monitor for ``simulated_diamond_sample``.
     """
     return get_path("DREAM_simple_pwd_workflow/Cave_TOF_Monitor_diam_in_can.dat")
@@ -135,6 +160,11 @@ def simulated_monitor_diamond_sample() -> str:
 def simulated_monitor_vanadium_sample() -> str:
     """Path to a Mcstas file for a monitor for the vanadium measurement.
 
+    SciCat:
+
+    - PID: ``20.500.12269/b170848e-455e-4c43-8666-68e20f922326``
+    - URL: https://staging.scicat.ess.eu/datasets/20.500.12269%2Fb170848e-455e-4c43-8666-68e20f922326
+
     This is the DREAM cave monitor for ``simulated_vanadium_sample``.
     """
     return get_path("DREAM_simple_pwd_workflow/Cave_TOF_Monitor_vana_inc_coh.dat")
@@ -143,6 +173,11 @@ def simulated_monitor_vanadium_sample() -> str:
 def simulated_monitor_empty_can() -> str:
     """Path to a Mcstas file for a monitor for the empty can measurement.
 
+    SciCat:
+
+    - PID: ``20.500.12269/1a280698-aa5a-4cfb-bc4f-68fcd40462cc``
+    - URL: https://staging.scicat.ess.eu/datasets/20.500.12269%2F1a280698-aa5a-4cfb-bc4f-68fcd40462cc
+
     This is the DREAM cave monitor for ``simulated_empty_can``.
     """
     return get_path("DREAM_simple_pwd_workflow/Cave_TOF_Monitor_van_can.dat")