ReflectX 1.0.0__tar.gz

reflectx-1.0.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: ReflectX
+Version: 1.0.0
+Summary: Reflected Light planet models
+Home-page: https://reflectx.readthedocs.io/en/latest/
+Author: Logan Pearce
+Author-email: Logan Pearce <lapearce@umich.edu>
+Project-URL: Documentation, https://reflectx.readthedocs.io
+Project-URL: Homepage, https://reflectx.readthedocs.io
+Project-URL: Repository, https://github.com/logan-pearce/ReflectX
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+Requires-Dist: numpy
+Requires-Dist: astropy
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Requires-Dist: corner
+Requires-Dist: h5py
+Requires-Dist: xarray
+Requires-Dist: h5netcdf
+Dynamic: author
+Dynamic: home-page
+
+ReflectX Model Suite of Exoplanet Reflected Light Spectra
+=========================================================
+
+.. image:: docs/source/images/reflectX-transp-white.png
+   :width: 60 %
+
+Suite of reflected light exoplanet models for direct imaging with MagAO-X, ELTs, and HWO. 
+
+More at:
+`https://reflectx.readthedocs.io/en/latest/index.html <https://reflectx.readthedocs.io/en/latest/index.html>`_

reflectx-1.0.0/README.rst

@@ -0,0 +1,10 @@
+ReflectX Model Suite of Exoplanet Reflected Light Spectra
+=========================================================
+
+.. image:: docs/source/images/reflectX-transp-white.png
+   :width: 60 %
+
+Suite of reflected light exoplanet models for direct imaging with MagAO-X, ELTs, and HWO. 
+
+More at:
+`https://reflectx.readthedocs.io/en/latest/index.html <https://reflectx.readthedocs.io/en/latest/index.html>`_

reflectx-1.0.0/ReflectX/ReflectX.py

@@ -0,0 +1,169 @@
+import numpy as np
+import astropy.constants as const
+import astropy.units as u
+import pandas as pd
+import pickle
+import scipy
+import xarray as xr
+import h5netcdf
+
+
+def LoadModel(path, Teff, Planet, CtoO, teq = None, phase = None, clouds = None):
+    """
+    Args:
+        path (str): Path to location of `ReflectX` folder containing models
+        Teff (int): Star effective temperature, must be 3000, 3500, 4000, 5000, or 7000
+        Planet (str): Specify planet (see docs for details of each planet type); must be Neptune, SuperNeptune, Saturn, Jupiter, or SuperJupiter
+        CtoO (float): Planet C/O ratio; must be 0.5, 1.0, or 1.5
+        teq (int): Planet equilibrium temperature; must be 75, 100, 150, 180, 200, 250, 300, or 500
+        phase (int): Planet viewing phase in degrees; must be 0, 45, 90, 120, or 140
+        clouds (dict): Dictionary of cloud properties, must contain keys `fsed` and `kzz`; fsed must be 0.1, 0.5, 1, 3, 6, 0r 10; kzz must be 1e9 or 1e11
+
+    Returns:
+        dict or XArray: entire model set as a dictionary or single spectrum as an XArray
+    """
+    loaded = {}
+    CtoO = str(CtoO).replace('.','')
+    filename = path + 'ReflectX/ReflectXGasGiantGrid/Teff'+str(Teff)+'/'+Planet+'/CtoO'+CtoO+'/model.nc'
+    with h5netcdf.File(filename, "r+") as f:
+        def recurse(group, prefix=""):
+            for name, subgrp in group.groups.items():
+                full_path = f"{prefix}/{name}".strip("/")
+                # If the subgroup contains variables, open it as an xarray dataset
+                if subgrp.variables:
+                    ds = xr.open_dataset(
+                        filename,
+                        engine="h5netcdf",
+                        group=full_path,
+                    )
+                    loaded[full_path] = ds
+                # Recurse deeper
+                recurse(subgrp, full_path)
+        recurse(f)
+    if teq == None:
+        return loaded
+    else:
+        key = 'teq'+str(teq)+'/phase'+str(phase)
+        if clouds == None:
+            key += '/cloudfree'
+        else:
+            if type(clouds['kzz']) == float:
+                kzz = '{:.0e}'.format(clouds['kzz'])
+            elif type(clouds['kzz']) == str:
+                kzz = clouds['kzz']
+            key += '/fsed'+str(clouds['fsed']).replace('.','')+'/kzz'+kzz
+        return loaded[key]
+
+def CreateGrid(min_wavelength, max_wavelength, constant_R):
+    """
+    Simple function to create a wavelength grid defined with a constant R.
+    Adapted from PICASO create_grid function
+    https://github.com/natashabatalha/picaso/blob/defc72955ad468496a814c1300e0f57244a75cd6/picaso/opacity_factory.py#L667C1-L694C27
+
+    Args:
+        min_wavelength (float): min value of wavelength range
+        max_wavelength (float): max value of wavelength range
+        constant_R (int): R value, ex: 10000
+
+    Returns:
+        arr: new wavelength grid at specified R value
+    """
+    spacing = (2.*constant_R+1.)/(2.*constant_R-1.)
+    
+    npts = np.log(max_wavelength/min_wavelength)/np.log(spacing)
+    
+    wsize = int(np.ceil(npts))+1
+    newwl = np.zeros(wsize)
+    newwl[0] = min_wavelength
+    
+    for j in range(1,wsize):
+        newwl[j] = newwl[j-1]*spacing
+    
+    return newwl
+    
+def MeanRegrid(x, y, newx=None, R=None):
+    """
+    Rebin the spectrum. Adapted from PICASO mean_regrid function
+    https://github.com/natashabatalha/picaso/blob/defc72955ad468496a814c1300e0f57244a75cd6/picaso/justplotit.py#L31C1-L63C19
+    
+    Args:
+        x (arr): wavelength array to be rebinned
+        y (arr): flux values to map to new wavelength grid
+        newx (arr): new wavelength array to map flux onto, required if R = None
+        R (int): desired R to construct new wavelength array to map flux onto, required if newx = None
+
+    Returns:
+        tuple containing
+
+        - newx (arr): new wavelength array
+        - newy (float): new flux array mapped onto new wavelength at desired R
+    """
+    from scipy.stats import binned_statistic
+    if (isinstance(newx, type(None)) & (not isinstance(R, type(None)))) :
+        newx = CreateGrid(min(x), max(x), R)
+    elif (not isinstance(newx, type(None)) & (isinstance(R, type(None)))) :  
+        d = np.diff(newx)
+        binedges = np.array([newx[0]-d[0]/2] + list(newx[0:-1]+d/2.0) + [newx[-1]+d[-1]/2])
+        newx = binedges
+    else: 
+        raise Exception('Please either enter a newx or a R') 
+    newy, edges, binnum = binned_statistic(x,y,bins=newx)
+    newx = (edges[0:-1]+edges[1:])/2.0
+
+    return newx, newy
+
+def LoadFilters():
+    '''
+    Load XArray of filter transmission profiles
+    '''
+    import os
+    file = os.path.join(os.path.dirname(__file__),"filters.nc")
+    filt = xr.open_dataset(file, engine="h5netcdf")
+    return filt
+
+def ScaleModelToStar(model, distance):
+    """
+    Scale star and planet flux arrays from surface to flux arriving at Earth
+
+    Args:
+        model (XArray): model XArray
+        distance (float): distance to star in parsecs
+
+    Returns:
+        XArray: XArray of model with star and planet flux scaled to flux arriving at Earth
+    """
+    omega = ((float(model.attrs['star.radius'])*u.Rsun / (distance*u.pc)).decompose())**2
+    data_vars=dict(starflux = (["wavelength"], 
+                                      model['starflux'].data * omega,
+                                      {'units': 'erg/cm**2/s/cm/'}),
+                   albedo = (["wavelength"], model['albedo'].data,{'units': ''}),
+                  fpfs = (["wavelength"], model['fpfs'].data,{'units': 'erg/cm**2/s/cm/'}),
+                  planetflux = (["wavelength"], model['starflux'].data * omega * model['fpfs'].data,{'units': 'erg/cm**2/s/cm/'})
+                  )
+    coords=dict(
+                wavelength=(["wavelength"], model.wavelength.values,{'units': 'micron'})
+            )
+    scaled_model = xr.Dataset(
+                data_vars=data_vars,
+                coords=coords,
+            )
+    return scaled_model
+
+def GetFluxInFilter(wavelength, flux, filtertransmission):
+    ''' Compute the average flux in a filter by multiplying the spectrum by the filter transmission curve
+    and dividing by the filter transmission curve
+    
+    Args:
+        wavelength (arr): wavelength array
+        flux (arr): flux array
+        filtertransmission (arr): filter transmission curve on same wavelength array
+
+    Returns:
+        float: weighted average flux in filter
+    '''
+    dl = [wavelength[i] - wavelength[i-1] for i in range(1,len(wavelength))]
+    dl.append(dl[-1])
+    filter_weighted_average = np.sum(flux * filtertransmission * wavelength * dl) / np.sum(filtertransmission * wavelength * dl)
+    return filter_weighted_average
+
+

reflectx-1.0.0/ReflectX/__init__.py

@@ -0,0 +1 @@
+from .ReflectX import *

reflectx-1.0.0/ReflectX.egg-info/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: ReflectX
+Version: 1.0.0
+Summary: Reflected Light planet models
+Home-page: https://reflectx.readthedocs.io/en/latest/
+Author: Logan Pearce
+Author-email: Logan Pearce <lapearce@umich.edu>
+Project-URL: Documentation, https://reflectx.readthedocs.io
+Project-URL: Homepage, https://reflectx.readthedocs.io
+Project-URL: Repository, https://github.com/logan-pearce/ReflectX
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+Requires-Dist: numpy
+Requires-Dist: astropy
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Requires-Dist: corner
+Requires-Dist: h5py
+Requires-Dist: xarray
+Requires-Dist: h5netcdf
+Dynamic: author
+Dynamic: home-page
+
+ReflectX Model Suite of Exoplanet Reflected Light Spectra
+=========================================================
+
+.. image:: docs/source/images/reflectX-transp-white.png
+   :width: 60 %
+
+Suite of reflected light exoplanet models for direct imaging with MagAO-X, ELTs, and HWO. 
+
+More at:
+`https://reflectx.readthedocs.io/en/latest/index.html <https://reflectx.readthedocs.io/en/latest/index.html>`_

reflectx-1.0.0/ReflectX.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.rst
+pyproject.toml
+setup.py
+ReflectX/ReflectX.py
+ReflectX/__init__.py
+ReflectX.egg-info/PKG-INFO
+ReflectX.egg-info/SOURCES.txt
+ReflectX.egg-info/dependency_links.txt
+ReflectX.egg-info/not-zip-safe
+ReflectX.egg-info/requires.txt
+ReflectX.egg-info/top_level.txt
+docs/source/conf.py

reflectx-1.0.0/ReflectX.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

reflectx-1.0.0/ReflectX.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

reflectx-1.0.0/ReflectX.egg-info/requires.txt

@@ -0,0 +1,8 @@
+numpy
+astropy
+scipy
+matplotlib
+corner
+h5py
+xarray
+h5netcdf

reflectx-1.0.0/ReflectX.egg-info/top_level.txt

@@ -0,0 +1,3 @@
+ReflectX
+dist
+docs

reflectx-1.0.0/docs/source/conf.py

@@ -0,0 +1,47 @@
+# Configuration file for the Sphinx documentation builder.
+
+# -- Project information
+
+project = 'ReflectX'
+copyright = 'Logan Pearce, 2026'
+author = 'Logan Pearce'
+
+release = '1.0'
+version = '1.0.0'
+
+# -- General configuration
+
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+]
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+}
+intersphinx_disabled_domains = ['std']
+
+templates_path = ['_templates']
+
+# -- Options for HTML output
+
+extensions = ["nbsphinx", 'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx','autoapi.extension',
+    'sphinx.ext.napoleon','sphinx_copybutton']
+html_theme = "sphinx_rtd_theme"
+html_logo = 'images/reflectX-transp.png'
+highlight_language = 'none'
+
+autoapi_dirs = ['../../ReflectX']
+autoapi_type = "python"
+
+
+# -- Options for EPUB output
+epub_show_urls = 'footnote'

reflectx-1.0.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = [
+    "setuptools", 
+    "numpy",
+    "cython", 
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ReflectX"
+dynamic = ["version"]
+dependencies = [
+    "numpy",
+    "astropy",
+    "scipy",
+    "matplotlib",
+    "corner",
+    "h5py",
+    "xarray",
+    "h5netcdf"
+]
+authors = [{name = "Logan Pearce", email = "lapearce@umich.edu"}]
+description = 'Reflected Light planet models'
+readme = "README.rst"
+requires-python = ">=3.9"
+
+[project.urls]
+Documentation = "https://reflectx.readthedocs.io"
+Homepage = "https://reflectx.readthedocs.io"
+Repository = "https://github.com/logan-pearce/ReflectX"
+
+[tool.setuptools.packages]
+find = {}

reflectx-1.0.0/setup.cfg

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

reflectx-1.0.0/setup.py

@@ -0,0 +1,12 @@
+from setuptools import setup
+
+setup(name='ReflectX',
+      version='1.0.0',
+      description='Reflected Light planet models',
+      url='https://reflectx.readthedocs.io/en/latest/',
+      author='Logan Pearce',
+      author_email='lapearce@umich.edu',
+      #license='MIT',
+      install_requires=['numpy','scipy','astropy','matplotlib','xarray', 'h5netcdf', 'h5py'],
+      packages=['ReflectX'],
+      zip_safe=False)