roman-dataref-test 2026.1.1__tar.gz

roman_dataref_test-2026.1.1/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: roman-dataref-test
+Version: 2026.1.1
+Summary: Reference data installer helper for Roman notebooks
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: requests
+Requires-Dist: pyyaml
+
+# Nancy Grace Roman Space Telescope Notebooks
+
+The `roman_notebooks` repository contains several workflows and tutorials that demonstrate how to simulate images from, access, and analyze data from the [Nancy Grace Roman Space Telescope](https://roman.gsfc.nasa.gov/) (Roman), as well as how to plan observations. Python Jupyter notebooks provide [Tutorials](markdown/tutorials.md) on specific topics (for example, running the science data pipeline to calibrate an exposure), while [Science Workflows](markdown/workflows.md) combine multiple tutorials with documentation to provide a guided, end-to-end experience for specific science use cases.
+
+The notebooks in this repository are designed for use with the [Roman Research Nexus](https://roman.science.stsci.edu), a cloud-based science platform developed for Roman users. With a [MyST](https://proper.stsci.edu/proper/authentication/auth) account, users can access the Nexus and work with Roman data directly in the cloud.
+
+## Repository Organization
+
+Notebook tutorials are organized under the `notebooks/` directory. Each notebook is contained within a folder along with a `requirements.txt` file and any supporting files required to run it.
+
+Reference and contributor documentation is in the repository root and in the `docs/` directory.
+
+## Local Installation
+
+The notebooks are optimized for execution on the Roman Research Nexus. For local setup instructions, see [install.rst](install.rst).
+
+## Get Support
+
+Please refer to the [Roman Documentation (RDox)](https://roman-docs.stsci.edu) website for technical documentation about the Roman Space Telescope .
+
+If you need assistance, submit a ticket through the [Roman Help Desk](https://romanhelp.stsci.edu) portal. Once logged in, select "Get Help with the Roman Space Telescope" and then the "Roman Research Nexus" category.

roman_dataref_test-2026.1.1/README.md

@@ -0,0 +1,21 @@
+# Nancy Grace Roman Space Telescope Notebooks
+
+The `roman_notebooks` repository contains several workflows and tutorials that demonstrate how to simulate images from, access, and analyze data from the [Nancy Grace Roman Space Telescope](https://roman.gsfc.nasa.gov/) (Roman), as well as how to plan observations. Python Jupyter notebooks provide [Tutorials](markdown/tutorials.md) on specific topics (for example, running the science data pipeline to calibrate an exposure), while [Science Workflows](markdown/workflows.md) combine multiple tutorials with documentation to provide a guided, end-to-end experience for specific science use cases.
+
+The notebooks in this repository are designed for use with the [Roman Research Nexus](https://roman.science.stsci.edu), a cloud-based science platform developed for Roman users. With a [MyST](https://proper.stsci.edu/proper/authentication/auth) account, users can access the Nexus and work with Roman data directly in the cloud.
+
+## Repository Organization
+
+Notebook tutorials are organized under the `notebooks/` directory. Each notebook is contained within a folder along with a `requirements.txt` file and any supporting files required to run it.
+
+Reference and contributor documentation is in the repository root and in the `docs/` directory.
+
+## Local Installation
+
+The notebooks are optimized for execution on the Roman Research Nexus. For local setup instructions, see [install.rst](install.rst).
+
+## Get Support
+
+Please refer to the [Roman Documentation (RDox)](https://roman-docs.stsci.edu) website for technical documentation about the Roman Space Telescope .
+
+If you need assistance, submit a ticket through the [Roman Help Desk](https://romanhelp.stsci.edu) portal. Once logged in, select "Get Help with the Roman Space Telescope" and then the "Roman Research Nexus" category.

roman_dataref_test-2026.1.1/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "roman-dataref-test"
+version = "2026.1.1"
+description = "Reference data installer helper for Roman notebooks"
+readme = "README.md"
+requires-python = ">=3.9"
+license-files = []
+dependencies = [
+    "requests",
+    "pyyaml",
+]
+
+[tool.setuptools]
+py-modules = ["notebook_data_dependencies"]
+
+[tool.setuptools.package-dir]
+"" = "shared"

roman_dataref_test-2026.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

roman_dataref_test-2026.1.1/shared/notebook_data_dependencies.py

@@ -0,0 +1,196 @@
+import os
+import requests
+import tarfile
+import tempfile
+import yaml
+from pathlib import Path
+from importlib.metadata import version as _pkg_version, PackageNotFoundError
+
+
+_DEPENDENCIES_PATH = Path(__file__).parent.parent / "refdata_dependencies.yaml"
+
+try:
+    _ref = "refs/tags/" + _pkg_version("roman-dataref-test")
+except PackageNotFoundError:
+    _ref = "refs/heads/main"
+
+_REFDATA_URL = (
+    f"https://raw.githubusercontent.com/spacetelescope/notebook-ci-testing"
+    f"/{_ref}/refdata_dependencies.yaml"
+)
+
+
+def _load_yaml(dependencies=None):
+    """Load YAML from local file or URL, preferring local when unspecified."""
+    if dependencies is None:
+        dependencies = str(_DEPENDENCIES_PATH) if _DEPENDENCIES_PATH.exists() else _REFDATA_URL
+
+    dep = str(dependencies)
+    if os.path.exists(dep):
+        with open(dep, "r") as f:
+            return yaml.safe_load(f)
+
+    req = requests.get(dep, allow_redirects=True, timeout=(10, 60))
+    req.raise_for_status()
+    return yaml.safe_load(req.content)
+
+
+def _invalid_env_value(envvar, value):
+    value = (value or "").strip()
+    if not value:
+        return True
+    if value == "***unset***" or value == f"${{{envvar}}}":
+        return True
+    return not os.path.exists(value)
+
+
+def install_files(dependencies=None, verbose=True, packages=None):
+    """
+    PURPOSE
+    -------
+    Retrieve ancillary reference data files needed for specific Python packages:
+        - pandeia
+        - STIPS
+        - STPSF
+        - synphot
+    
+    This code checks for each package that the appropriate environment variable exists 
+    and, if not, it downloads the reference data to the path indicated in the YAML 
+    instructions and returns instructions to the user for how to set the variables.
+    
+    INPUTS
+    ------
+    dependencies (str): A URL or local path to the YAML definition file for the data 
+    dependencies. The code will first check for the existence of the file locally, and 
+    if it does not exist then it will assume the input is a URL. The default is the URL 
+    of the file on the notebook-ci-testing GitHub repository. The YAML file should have the 
+    following format:
+            
+        package_name:  # Name of the package
+            version:  # Package version number for documentation
+            data_url:  # URL for each tarball to pull (can provide multiple, e.g., synphot)
+                - URL_1
+                ...
+                - URL_N
+            environment_variable:  # Environment variable to check or set up (e.g., PYSYN_CDBS)
+            install_path:  # Parent directory under which to install the reference data
+            data_path:  # Name of the folder that the reference data exists in
+                
+        The variable data_path is appended to install_path to give the final path to the reference
+        data in the file system.
+
+    verbose (bool): Print messages to the standard out. Default is False.
+    
+    packages (None, list, str): List of packages for which to install reference data. This can
+    be a list of string package names, a comma separated string of package names, or None. If None, 
+    then install package reference data for all packages in the dependencies file. Default None.
+        
+    RETURNS
+    -------
+    results (dict): A dictionary for each environment variable with the value equal to the final
+        path to which the variable should be set.
+    """
+    
+    # Local YAML is preferred when available, otherwise tag-aware remote fallback.
+    yf = _load_yaml(dependencies)['install_files']
+
+    # If only installing certain packages, check that now and limit the dictionary to
+    # just those package keys.
+    if packages:
+        if isinstance(packages, str):
+            packages = [p.strip() for p in packages.split(',') if p.strip()]
+
+        keys = list(yf.keys())
+        skips = [k  for k in keys if k not in packages]
+        for s in skips:
+            _ = yf.pop(s)
+
+    # Loop over packages defined in the dependencies dictionary.
+    home = os.environ.get('HOME', os.path.expanduser('~'))
+    result = {}
+    for package in yf.keys():
+        envvar = yf[package]['environment_variable']
+        try:
+            test = os.environ.get(envvar, '')
+            if _invalid_env_value(envvar, test):
+                raise KeyError('UNSET PATH')
+            if verbose:
+                print(f"Found {package} path {os.environ[envvar]}")
+            result[envvar] = {'path': os.environ[envvar], 'pre_installed': True}
+        except KeyError:
+            if verbose:
+                print(f"Did not find {package} data in environment, setting it up...")
+
+            # Get the path where the data should be installed. Resolve any environment variables.
+            env_path = yf[package]['install_path']
+            tmp_path = env_path.split('/')
+            tmp_path = [home if '${HOME}' in tp else tp for tp in tmp_path]
+            final_path = '/'.join(tmp_path)
+
+            # Check if path directory structure exists. If not, make it.
+            if not os.path.isdir(final_path):
+                os.makedirs(final_path, exist_ok=True)
+
+            # Download the tarball from the URL in the YAML file and extract the files.
+            tot_files = len(yf[package]['data_url'])
+            if verbose:
+                print(f"\tDownloading and uncompressing file...")
+                print(f"\tFound {tot_files} data URL(s) to download and install...")
+            for i, url in enumerate(yf[package]['data_url']):
+                if verbose:
+                    print(f"\tWorking on file {i+1} out of {tot_files}")
+                req = requests.get(url, allow_redirects=True, stream=True, timeout=(10, 300))
+                req.raise_for_status()
+                with tempfile.NamedTemporaryFile(dir=final_path, suffix='.tar.gz', delete=False) as tmp:
+                    tmp_name = tmp.name
+                    for chunk in req.iter_content(chunk_size=8192):
+                        tmp.write(chunk)
+                try:
+                    with tarfile.open(tmp_name) as tarball:
+                        tarball.extractall(path=final_path, filter='data')
+                finally:
+                    os.remove(tmp_name)
+
+            # Messages to the user
+            if verbose:
+                print(f"\tUpdate environment variable with the following:")
+                print(f"\t\texport {yf[package]['environment_variable']}='{os.path.join(final_path, yf[package]['data_path'])}'")
+            result[envvar] = {'path': os.path.join(final_path, yf[package]['data_path']), 'pre_installed': False}
+
+    # Return the environment variables and paths to the user as a dictionary so that they
+    # can be set programmatically.
+    return result
+
+def setup_env(result, dependencies=None, verbose=True):
+    # Update environment variables (if necessary) and print reference data paths
+    print('Reference data paths set to:')
+    for k, v in result.items():
+        if not v['pre_installed']:
+            os.environ[k] = v['path']
+        print(f"\t{k} = {v['path']}")
+
+    # Apply additional environment variables from YAML (for example CRDS vars).
+    yf = _load_yaml(dependencies)
+    other = yf.get('other_variables', {})
+    home = os.environ.get('HOME', os.path.expanduser('~'))
+    for key, value in other.items():
+        value = str(value).replace('${HOME}', home)
+        current = (os.environ.get(key) or '').strip()
+
+        # Replace clearly invalid placeholders and malformed CRDS URL values.
+        invalid_current = (
+            not current
+            or current == '***unset***'
+            or current == f'${{{key}}}'
+            or (key == 'CRDS_SERVER_URL' and not current.startswith('https://'))
+        )
+
+        if invalid_current:
+            os.environ[key] = value
+            if verbose:
+                print(f"\t{key} = {value}")
+        elif verbose:
+            print(f"\t{key} = {os.environ[key]} (pre-set, not overwritten)")
+
+if __name__ == '__main__':
+    setup_env(install_files())

roman_dataref_test-2026.1.1/shared/roman_dataref_test.egg-info/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: roman-dataref-test
+Version: 2026.1.1
+Summary: Reference data installer helper for Roman notebooks
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: requests
+Requires-Dist: pyyaml
+
+# Nancy Grace Roman Space Telescope Notebooks
+
+The `roman_notebooks` repository contains several workflows and tutorials that demonstrate how to simulate images from, access, and analyze data from the [Nancy Grace Roman Space Telescope](https://roman.gsfc.nasa.gov/) (Roman), as well as how to plan observations. Python Jupyter notebooks provide [Tutorials](markdown/tutorials.md) on specific topics (for example, running the science data pipeline to calibrate an exposure), while [Science Workflows](markdown/workflows.md) combine multiple tutorials with documentation to provide a guided, end-to-end experience for specific science use cases.
+
+The notebooks in this repository are designed for use with the [Roman Research Nexus](https://roman.science.stsci.edu), a cloud-based science platform developed for Roman users. With a [MyST](https://proper.stsci.edu/proper/authentication/auth) account, users can access the Nexus and work with Roman data directly in the cloud.
+
+## Repository Organization
+
+Notebook tutorials are organized under the `notebooks/` directory. Each notebook is contained within a folder along with a `requirements.txt` file and any supporting files required to run it.
+
+Reference and contributor documentation is in the repository root and in the `docs/` directory.
+
+## Local Installation
+
+The notebooks are optimized for execution on the Roman Research Nexus. For local setup instructions, see [install.rst](install.rst).
+
+## Get Support
+
+Please refer to the [Roman Documentation (RDox)](https://roman-docs.stsci.edu) website for technical documentation about the Roman Space Telescope .
+
+If you need assistance, submit a ticket through the [Roman Help Desk](https://romanhelp.stsci.edu) portal. Once logged in, select "Get Help with the Roman Space Telescope" and then the "Roman Research Nexus" category.

roman_dataref_test-2026.1.1/shared/roman_dataref_test.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+README.md
+pyproject.toml
+shared/notebook_data_dependencies.py
+shared/roman_dataref_test.egg-info/PKG-INFO
+shared/roman_dataref_test.egg-info/SOURCES.txt
+shared/roman_dataref_test.egg-info/dependency_links.txt
+shared/roman_dataref_test.egg-info/requires.txt
+shared/roman_dataref_test.egg-info/top_level.txt

roman_dataref_test-2026.1.1/shared/roman_dataref_test.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

roman_dataref_test-2026.1.1/shared/roman_dataref_test.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests
+pyyaml

roman_dataref_test-2026.1.1/shared/roman_dataref_test.egg-info/top_level.txt

@@ -0,0 +1 @@
+notebook_data_dependencies