roman-snpit-snappl 0.8.0__tar.gz → 0.9.0__tar.gz

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0}/.cruft.json

@@ -1,11 +1,12 @@
 {
   "template": "https://github.com/Roman-Supernova-PIT/package-template",
-  "commit": "9d156bb4c476043b6c616e3e41047b68d4d89cdd",
+  "commit": "b234ef0121cba44b08e9f9095e1bd66380c043be",
   "checkout": null,
   "context": {
     "cookiecutter": {
       "package_name": "roman_snpit_snappl",
       "module_name": "snappl",
+      "github_snpit_repo_name": "snappl",
       "short_description": "Photometry utilities for the Roman SNPIT",
       "author_name": "Roman SN PIT",
       "author_email": "raknop@lbl.gov",
@@ -16,7 +17,7 @@
       "include_github_workflows": "y",
       "_project_url": "https://github.com/Roman-Supernova-PIT",
       "_pit_github_org": "Roman-Supernova-PIT",
-      "_pit_name": "Roman Supernove Project Infrastructure Team",
+      "_pit_name": "Roman Supernova Project Infrastructure Team",
       "_sphinx_theme": "alabaster",
       "_parent_project": "",
       "install_requires": "",
@@ -27,7 +28,7 @@
         ".github/"
       ],
       "_template": "https://github.com/Roman-Supernova-PIT/package-template",
-      "_commit": "9d156bb4c476043b6c616e3e41047b68d4d89cdd"
+      "_commit": "b234ef0121cba44b08e9f9095e1bd66380c043be"
     }
   },
   "directory": null

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0}/.github/workflows/run_labeler.yml

@@ -15,8 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9  # v5.0.0
-          with:
-            repo-token: "${{ secrets.GITHUB_TOKEN }}"
-            sync-labels: true  # removes labels when files reverted
-            configuration-path: .github/labeler.yml
-          
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          sync-labels: true  # removes labels when files reverted
+          configuration-path: .github/labeler.yml

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0}/.github/workflows/run_snappl_tests.yml

@@ -33,7 +33,16 @@ jobs:
         with:
           repository: Roman-Supernova-PIT/photometry_test_data
           path: photometry_test_data
-          
+
+      - name: lfs pull photometry test data
+        run: |
+          git lfs install --local
+          AUTH=$(git config --local http.${{ github.server_url }}/.extraheader)
+          git config --local --unset http.${{ github.server_url }}/.extraheader
+          git config --local http.${{ github.server_url }}/${{ github.repository }}.git/info/lfs/objects/batch.extraheader "$AUTH"
+          git lfs pull
+        working-directory: photometry_test_data
+
       - name: log into github container registry
         uses: docker/login-action@v3
         with:

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0}/.github/workflows/sphinx-deploy.yml

@@ -13,7 +13,7 @@ jobs:
       contents: write
     steps:
     - id: deployment
-      uses: sphinx-notes/pages@3a7b173ecba074b270b37c64007c1edfd8465892  # v3.1
+      uses: sphinx-notes/pages@23ef64097ef9b00d8f71e978bc518ee32ca98651  # v3.2
       with:
         publish: false
         documentation_path: ./docs

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0}/CITATION.cff

@@ -8,4 +8,4 @@ title: roman_snpit_snappl
 version: 0.0
 doi: 
 date-released: 
-url: "https://github.com/Roman-Supernova-PIT/roman_snpit_snappl"
+url: "https://github.com/Roman-Supernova-PIT/snappl"

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0}/LICENSE

@@ -1,6 +1,6 @@
 BSD-3-Clause LICENSE
 
-Copyright (c) 2025, Roman Supernove Project Infrastructure Team
+Copyright (c) 2025, Roman Supernova Project Infrastructure Team
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

{roman_snpit_snappl-0.8.0/roman_snpit_snappl.egg-info → roman_snpit_snappl-0.9.0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: roman_snpit_snappl
-Version: 0.8.0
+Version: 0.9.0
 Summary: Photometry utilities for the Roman SNPIT
-Author: Roman Supernove Project Infrastructure Team
+Author: Roman Supernova Project Infrastructure Team
 Maintainer-email: Roman SN PIT <raknop@lbl.gov>
 Project-URL: repository, https://github.com/Roman-Supernova-PIT
 Classifier: Development Status :: 3 - Alpha
@@ -10,6 +10,14 @@ Classifier: Programming Language :: Python
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: astropy
+Requires-Dist: photutils
+Requires-Dist: pandas
+Requires-Dist: h5py
+Requires-Dist: roman-datamodels
+Requires-Dist: snpit_utils
 Requires-Dist: towncrier
 Requires-Dist: setuptools_scm
 Requires-Dist: cruft
@@ -26,6 +34,7 @@ Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-automodapi; extra == "docs"
 Requires-Dist: matplotlib; extra == "docs"
 Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: mock; extra == "docs"
 Requires-Dist: tomli; extra == "docs"
 Requires-Dist: graphviz; extra == "docs"
 Dynamic: license-file

roman_snpit_snappl-0.9.0/changes/29.feature.rst

@@ -0,0 +1 @@
+Add RomanDatamodelImage, GWCS

roman_snpit_snappl-0.9.0/changes/47.feature.rst

@@ -0,0 +1 @@
+Add DiaObject, ImageFinder, and ImageCollection

roman_snpit_snappl-0.9.0/changes/49.docs.rst

@@ -0,0 +1 @@
+Update code and docs so that API is included in docs

roman_snpit_snappl-0.9.0/docs/api.rst

@@ -0,0 +1,15 @@
+.. _api:
+
+==========
+snappl API
+==========
+
+.. contents::
+
+.. automodapi:: snappl.image
+
+.. automodapi:: snappl.wcs
+
+.. automodapi:: snappl.psf
+
+.. automodapi:: snappl.sed

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0}/docs/conf.py

@@ -16,18 +16,47 @@ import sphinx
 
 from sphinx.ext.autodoc import AttributeDocumenter
 
+# -- Getting docs to build outside the SNPIT docker image --------------------
+
+# See section "Previewing your Documentation" in the package template
+# docs.  The addition to sys.path is needed to find your module's code
+# if you aren't able to `pip install -e .` your module in a venv.  The
+# autodock_mock_imports and/or things_to_mock variable tells Sphinx not
+# to try to import those specific modules.
+
+# sys.path.insert( 0, str( pathlib.Path( '..' ).resolve() ) )
+# autodoc_mock_imports = [ 'roman_imsim' ]
+
+# ...unfortunately, while autodoc_mock_imports works the autmodule
+#    directive, it does not work with the automodapi directive.  See
+#    https://github.com/astropy/sphinx-automodapi/issues/148
+#
+# So, instead, we do it manually.  You will need to add mock to
+#   the docs list in [project.optional-dependencies] in pyproject.toml.
+import mock
+things_to_mock = [ 'galsim', 'galsim.roman', 'roman_imsim', 'roman_imsim.utils' ]
+for mod in things_to_mock:
+    sys.modules[ mod ] = mock.MagicMock()
+
+
+
 # -- Project information -----------------------------------------------------
 
 # to populate metadata from the pyproject.toml file so that changes are picked 
 # up for things in the project section of the toml
 with open("../pyproject.toml", "rb") as metadata_file:
-    metadata = tomli.load(metadata_file)['project']
-    project = metadata['name']
+    pyptoml = tomli.load( metadata_file )
+    project = pyptoml['project']['name']
+    # In the Roman SNPIT pyproject.tom, the module to include
+    #   is in tool.setuptools.packages.find.include, which is
+    #   a list; the first element of the list is the module
+    #   name, but it ends in a *.  Strip that.
+    module_name = pyptoml['tool']['setuptools']['packages']['find']['include'][0][:-1]
     author = 'Roman Supernova PIT'
 
 copyright = f'{datetime.datetime.today().year}, {author}'
 
-package = importlib.import_module(project)
+package = importlib.import_module(module_name)
 try:
     version = package.__version__.split('-', 1)[0]
     # The full version, including alpha/beta/rc tags.
@@ -109,6 +138,8 @@ html_theme_options = {
     'logo_text_align': "left",
     'description': "Software developed by the Roman SNPIT",
     'sidebar_width':'250px',
+    'page_width':'75%',
+    'body_max_width':'120ex',
     'show_relbars':True,
 }
 

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0}/docs/index.rst

@@ -22,7 +22,7 @@ the github package repository at https://github.com/Roman-Supernova-PIT/roman_sn
    installation.rst
    usage.rst
    changes.rst
-
+   api.rst
 
 
 Indices and tables

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0}/docs/installation.rst

@@ -32,13 +32,13 @@ You can either clone the public repository:
 
 .. code-block:: console
 
-    $ git clone git@github.com:Roman-Supernova-PIT/roman_snpit_snappl.git
+    $ git clone git@github.com:Roman-Supernova-PIT/snappl.git
 
 Or download the `tarball`_:
 
 .. code-block:: console
 
-    $ curl -OJL https://github.com/Roman-Supernova-PIT/roman_snpit_snappl/tarball/master
+    $ curl -OJL https://github.com/Roman-Supernova-PIT/snappl/tarball/master
 
 Once you have a copy of the source, you can install it with:
 
@@ -54,5 +54,5 @@ If you would like to do an editable install:
     $ pip install -e .[docs]  # install document build packages during install
 
 
-.. _Github repo: https://github.com/Roman-Supernova-PIT/roman_snpit_snappl
-.. _tarball: https://github.com/Roman-Supernova-PIT/roman_snpit_snappl/tarball/master
+.. _Github repo: https://github.com/Roman-Supernova-PIT/snappl
+.. _tarball: https://github.com/Roman-Supernova-PIT/snappl/tarball/master

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "roman_snpit_snappl"
 description = "Photometry utilities for the Roman SNPIT"
 requires-python = ">=3.11"
 dynamic = ["version"]
-authors = [{ name = "Roman Supernove Project Infrastructure Team"}]
+authors = [{ name = "Roman Supernova Project Infrastructure Team"}]
 
 maintainers = [
  {name = "Roman SN PIT", email = "raknop@lbl.gov"}
@@ -17,6 +17,14 @@ classifiers = [
   "Programming Language :: Python"
 ]
 dependencies = [
+  "numpy",
+  "scipy",
+  "astropy",
+  "photutils",
+  "pandas",
+  "h5py",
+  "roman-datamodels",
+  "snpit_utils",
   "towncrier",
   "setuptools_scm",
   "cruft",
@@ -48,6 +56,7 @@ docs = [
     "sphinx-automodapi",
     "matplotlib",
     "sphinx",
+    "mock",
     "tomli",
     "graphviz"
 ]

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0/roman_snpit_snappl.egg-info}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: roman_snpit_snappl
-Version: 0.8.0
+Version: 0.9.0
 Summary: Photometry utilities for the Roman SNPIT
-Author: Roman Supernove Project Infrastructure Team
+Author: Roman Supernova Project Infrastructure Team
 Maintainer-email: Roman SN PIT <raknop@lbl.gov>
 Project-URL: repository, https://github.com/Roman-Supernova-PIT
 Classifier: Development Status :: 3 - Alpha
@@ -10,6 +10,14 @@ Classifier: Programming Language :: Python
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: astropy
+Requires-Dist: photutils
+Requires-Dist: pandas
+Requires-Dist: h5py
+Requires-Dist: roman-datamodels
+Requires-Dist: snpit_utils
 Requires-Dist: towncrier
 Requires-Dist: setuptools_scm
 Requires-Dist: cruft
@@ -26,6 +34,7 @@ Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-automodapi; extra == "docs"
 Requires-Dist: matplotlib; extra == "docs"
 Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: mock; extra == "docs"
 Requires-Dist: tomli; extra == "docs"
 Requires-Dist: graphviz; extra == "docs"
 Dynamic: license-file

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0}/roman_snpit_snappl.egg-info/SOURCES.txt

@@ -33,6 +33,7 @@ changes/18.feature.rst
 changes/20.bugfix.rst
 changes/23.snappl.rst
 changes/26.feature.rst
+changes/29.feature.rst
 changes/3.snappl.rst
 changes/31.feature.rst
 changes/35.snappl.rst
@@ -41,10 +42,13 @@ changes/37.snappl.rst
 changes/40.snappl.rst
 changes/41.snappl.rst
 changes/43.snappl.rst
+changes/47.feature.rst
+changes/49.docs.rst
 changes/5.snappl.rst
 changes/8.snappl.rst
 changes/9.snappl.rst
 docs/Makefile
+docs/api.rst
 docs/changes.rst
 docs/conf.py
 docs/index.rst
@@ -66,7 +70,9 @@ roman_snpit_snappl.egg-info/requires.txt
 roman_snpit_snappl.egg-info/top_level.txt
 snappl/__init__.py
 snappl/_version.py
+snappl/diaobject.py
 snappl/image.py
+snappl/imagecollection.py
 snappl/psf.py
 snappl/sed.py
 snappl/wcs.py

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0}/roman_snpit_snappl.egg-info/requires.txt

@@ -1,3 +1,11 @@
+numpy
+scipy
+astropy
+photutils
+pandas
+h5py
+roman-datamodels
+snpit_utils
 towncrier
 setuptools_scm
 cruft
@@ -7,6 +15,7 @@ coverage
 sphinx
 sphinx-automodapi
 matplotlib
+mock
 tomli
 graphviz
 

{roman_snpit_snappl-0.8.0 → roman_snpit_snappl-0.9.0}/snappl/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.8.0'
-__version_tuple__ = version_tuple = (0, 8, 0)
+__version__ = version = '0.9.0'
+__version_tuple__ = version_tuple = (0, 9, 0)
 
-__commit_id__ = commit_id = 'gfdb162af4'
+__commit_id__ = commit_id = 'gf264c1a86'

roman_snpit_snappl-0.9.0/snappl/diaobject.py

@@ -0,0 +1,231 @@
+__all__ = [ 'DiaObject', 'DiaObjectOU2024', 'DiaObjectManual' ]
+
+from snpit_utils.http import retry_post
+
+
+class DiaObject:
+    """Encapsulate a single supernova (or other transient).
+
+    Standard properties:
+
+    ra : ra in degrees (ICRS)
+    dec : dec in degrees (ICRS)
+
+    mjd_discovery : when the object was first discovered; may be None if unknown (float MJD)
+    mjd_peak : peak of the object's lightcurve; may be None if unknown (float MJD)
+
+    mjd_start : MJD when the lightcurve first exists.  Definition of this
+                is class-dependent; it may be when it was actively
+                simulated, but it may be when the lightcurve is above some
+                cutoff.  May be None if unknown.
+
+    mjd_end : MJD when the lightcurve stops existing.  Definition like
+              mjd_start.  May be None if unknown.
+
+    Some subclasses may support additional properties, but use those
+    with care, as you are making your code less generral when you use
+    them.
+
+    This is an abstract base class.  If you must, instantiate subclass
+    objects directly.  If you want to find an existing object, use the
+    find_objects class method.
+
+    """
+
+    def __init__( self, id=None, ra=None, dec=None, mjd_discovery=None, mjd_peak=None,
+                  mjd_start=None, mjd_end=None, _called_from_find_objects=False ):
+        """Don't call a DiaObject or subclass constructor.  Use DiaOjbect.find_objects."""
+        if not _called_from_find_objects:
+            raise RuntimeError( "Don't call a DiaObject or subclass constructor.  Use DiaObject.find_objects." )
+        self.id = id
+        self.ra = ra
+        self.dec = dec
+        self.mjd_discovery = mjd_discovery
+        self.mjd_peak = mjd_peak
+        self.mjd_start = mjd_start
+        self.mjd_end = mjd_end
+
+    @classmethod
+    def find_objects( cls, collection=None, subset=None, **kwargs ):
+        """Find objects.
+
+        Parameters
+        ----------
+          collection : str
+            Which collection of object to search.  Currently only
+            "ou2024" and "manuasl" are implemented, but others will be later.
+
+          subset : str
+            Subset of collection to search.  Many collections (including
+            ou2024) will ignore this.
+
+          id : <something>
+            The ID of the object.  Should work as a str.  This is an
+            opaque thing that will be different for different
+            collections.
+
+          ra: float
+            RA in degrees to search.
+
+          dec: float
+            Dec in degrees to search.
+
+          radius: float, default 1.0
+            Radius in arcseconds to search.  Ignored unless ra and dec are given.
+
+          mjd_peak_min, mjd_peak_max: float
+            Only return objects whose mjd_peak is between these limits.
+            Specify as MJD.  Will not return any objects with unknown
+            mjd_peak.
+
+          mjd_discovery_min, mjd_discovery_max: float
+            Only return objects whose mjd_discovery is between these
+            limits.  Specify as MJD.  Wil not return any objects with
+            unknown mjd_discovery.
+
+          mjd_start_min, mjd_start_max: float
+
+          mjd_end_min, mjd_end_max: float
+
+
+        Returns
+        -------
+          list of DiaObject
+
+          In reality, it will be a list of objects of a subclass of
+          DiaObject, but the calling code should not know or depend on
+          that, it should treat them all as just DiaObject objects.
+
+        """
+
+        if collection == 'ou2024':
+            return DiaObjectOU2024._find_objects( subset=subset, **kwargs )
+        elif collection == 'manual':
+            return DiaObjectManual._find_objects( subset=subset, **kwargs )
+        else:
+            raise ValueError( f"Unknown collection {collection}" )
+
+    @classmethod
+    def _find_objects( cls, subset=None, **kwargs ):
+        raise NotImplementedError( f"{cls.__name__} needs to implement _find_objects" )
+
+
+# ======================================================================
+
+class DiaObjectOU2024( DiaObject ):
+    """A transient from the OpenUniverse 2024 sims."""
+
+    def __init__( self, *args, **kwargs ):
+        """Don't call a DiaObject or subclass constructor.  Use DiaOjbect.find_objects."""
+        super().__init__( *args, **kwargs )
+
+        # Non-standard fields
+        self.host_id = None
+        self.gentype = None
+        self.model_name = None
+        self.start_mjd = None
+        self.end_mjd = None
+        self.z_cmb = None
+        self.mw_ebv = None
+        self.mw_extinction_applied = None
+        self.av = None
+        self.rv = None
+        self.v_pec = None
+        self.host_ra = None
+        self.host_dec = None
+        self.host_mag_g = None
+        self.host_mag_i = None
+        self.host_mag_f = None
+        self.host_sn_sep = None
+        self.peak_mag_g = None
+        self.peak_mag_i = None
+        self.peak_mag_f = None
+        self.lens_dmu = None
+        self.lens_dmu_applied = None
+        self.model_params = None
+
+    @classmethod
+    def _find_objects( cls, subset=None,
+                       id=None,
+                       ra=None,
+                       dec=None,
+                       radius=1.0,
+                       mjd_peak_min=None,
+                       mjd_peak_max=None,
+                       mjd_discovery_min=None,
+                       mjd_discovery_max=None,
+                       mjd_start_min=None,
+                       mjd_start_max=None,
+                       mjd_end_min=None,
+                       mjd_end_max=None,
+                      ):
+        if any( i is not None for i in [ mjd_peak_min, mjd_peak_max, mjd_discovery_min, mjd_discovery_max ] ):
+            raise NotImplementedError( "DiaObjectOU2024 doesn't support searching on mjd_peak or mjd_discovery" )
+
+        params = {}
+
+        if ( ra is None ) != ( dec is None ):
+            raise ValueError( "Pass both or neither of ra/dec, not just one." )
+
+        if ra is not None:
+            if radius is None:
+                raise ValueError( "ra/dec requires a radius" )
+            params['ra'] = float( ra )
+            params['dec'] = float( dec )
+            params['radius'] = float( radius )
+
+        if id is not None:
+            params['id'] = int( id )
+
+        if mjd_start_min is not None:
+            params['mjd_start_min'] = float( mjd_start_min )
+
+        if mjd_start_max is not None:
+            params['mjd_start_max'] = float( mjd_start_max )
+
+        if mjd_end_min is not None:
+            params['mjd_end_min'] = float( mjd_end_min )
+
+        if mjd_end_min is not None:
+            params['mjd_end_max'] = float( mjd_end_max )
+
+
+        res = retry_post( 'https://roman-desc-simdex.lbl.gov/findtransients', json=params )
+        objinfo = res.json()
+
+        diaobjects = []
+        for i in range( len( objinfo['id'] ) ):
+            diaobj = DiaObjectOU2024( id=objinfo['id'][i],
+                                      ra=objinfo['ra'][i],
+                                      dec=objinfo['dec'][i],
+                                      mjd_peak=objinfo['peak_mjd'][i],
+                                      mjd_start=objinfo['start_mjd'][i],
+                                      mjd_end=objinfo['end_mjd'][i],
+                                      _called_from_find_objects=True
+                                     )
+            for prop in ( [ 'healpix', 'host_id', 'gentype', 'model_name', 'z_cmb', 'mw_ebv', 'mw_extinction_applied',
+                            'av', 'rv', 'v_pec', 'host_ra', 'host_dec', 'host_mag_g', 'host_mag_i', 'host_mag_f',
+                            'host_sn_sep', 'peak_mag_g', 'peak_mag_i', 'peak_mag_f', 'lens_dmu',
+                            'lens_dmu_applied', 'model_params' ] ):
+                setattr( diaobj, prop, objinfo[prop][i] )
+            diaobjects.append( diaobj )
+
+        return diaobjects
+
+
+# ======================================================================
+
+class DiaObjectManual( DiaObject ):
+    """A manually-specified object that's not saved anywhere."""
+
+    def __init__( self, *args, **kwargs ):
+        """Don't call a DiaObject or subclass constructor.  Use DiaOjbect.find_objects."""
+        super().__init__( *args, **kwargs )
+
+
+    @classmethod
+    def _find_objects( cls, collection=None, subset=None, **kwargs ):
+        if any( ( i not in kwargs ) or ( kwargs[i] is None ) for i in ('id', 'ra', 'dec') ):
+            raise ValueError( "finding a manual DiaObject requires all of id, ra, and dec" )
+
+        return [ DiaObjectManual( _called_from_find_objects=True, **kwargs ) ]