astro-otter 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

{astro_otter-0.0.1.dist-info → astro_otter-0.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: astro-otter
-Version: 0.0.1
+Version: 0.0.2
 Author-email: Noah Franz <nfranz@arizona.edu>
 License: MIT License
         
@@ -50,6 +50,13 @@ Requires-Dist: synphot
 Requires-Dist: ads
 Requires-Dist: ruff
 Requires-Dist: pre-commit
+Requires-Dist: Sphinx >=3.0.0
+Requires-Dist: myst-parser >=0.13
+Requires-Dist: nbsphinx >=0.9.1
+Requires-Dist: sphinx-book-theme >=0.0.33
+Requires-Dist: sphinx-copybutton
+Requires-Dist: autodoc
+Requires-Dist: ipykernel
 
 # OTTER API
 ### **O**pen mul**T**iwavelength **T**ransient **E**vent **R**epository
@@ -66,9 +73,9 @@ A Python API for the OTTER.
 [github-discussions-link]:  https://github.com/mattbellis/hepfile/discussions
 [gitter-badge]:             https://badges.gitter.im/https://github.com/mattbellis/hepfile/community.svg
 [gitter-link]:              https://gitter.im/https://github.com/mattbellis/hepfile/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
-[pypi-link]:                https://pypi.org/project/hepfile/
-[pypi-platforms]:           https://img.shields.io/pypi/pyversions/hepfile
-[pypi-version]:             https://badge.fury.io/py/hepfile.svg
+[pypi-link]:                https://pypi.org/project/astro-otter/
+[pypi-platforms]:           https://img.shields.io/pypi/pyversions/astro-otter
+[pypi-version]:             https://badge.fury.io/py/astro-otter.svg
 [rtd-badge]:                https://readthedocs.org/projects/otter/badge/?version=latest
 [rtd-link]:                 https://otter.readthedocs.io/en/latest/?badge=latest
 [sk-badge]:                 https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
@@ -77,7 +84,9 @@ A Python API for the OTTER.
 [codecov-badge]:            https://codecov.io/gh/astro-otter/otter/graph/badge.svg?token=BtCerOdTc0
 [codecov-link]:             https://codecov.io/gh/astro-otter/otter
 
+[![Documentation Status](https://readthedocs.org/projects/astro-otter/badge/?version=latest)](https://astro-otter.readthedocs.io/en/latest/?badge=latest)
 [![Actions Status][actions-badge]][actions-link]
+[![PyPI version][pypi-version]][pypi-link]
 [![Linting: Ruff][ruff-badge]][ruff-link]
 [![codecov][codecov-badge]][codecov-link]
 

astro_otter-0.0.2.dist-info/RECORD

@@ -0,0 +1,15 @@
+otter/__init__.py,sha256=QcHr5dccvRTbhHvmYPxeA3Tu_cTPSaly6HpWpYIOKuE,375
+otter/_version.py,sha256=LmHTKaM1wouerxDnWDFcgY_MwrMKXJg7gfYzgnpWjcA,76
+otter/exceptions.py,sha256=d2g7Lmh8k06P8C_No2yX38nM9Si_Xh60n09d8BEtO60,938
+otter/util.py,sha256=3_Vi3ufPcquHJSnS7VvLEQ5SPhSElHDt0WZGbFJ_Vbo,15163
+otter/io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+otter/io/otter.py,sha256=KCRU8KHGVqz4BItqLj5U7eLBOi_rBGEFU1rcCOABh0E,17608
+otter/io/transient.py,sha256=COp8itX3P70eXXDKhs-m4lOZI5IzlJHSB59XGRy9gg0,33621
+otter/plotter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+otter/plotter/otter_plotter.py,sha256=iQe5AFsB5plw5eClUfuEfqcNRiXEcKc5-hkLPVKCkg8,2091
+otter/plotter/plotter.py,sha256=i9ZAlbIjftpzyFzgCIFdye9XnppTwOSwazb5ruLpjnE,2896
+astro_otter-0.0.2.dist-info/LICENSE,sha256=s9IPE8A3CAMEaZpDhj4eaorpmfLYGB0mIGphq301PUY,1067
+astro_otter-0.0.2.dist-info/METADATA,sha256=Tw9V-rhA8kudxXJjlPWrGMcNdJbnwvYIxolUCgQ-VCw,32275
+astro_otter-0.0.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+astro_otter-0.0.2.dist-info/top_level.txt,sha256=Wth72sCwBRUk3KZGknSKvLQDMFuJk6qiaAavMDOdG5k,6
+astro_otter-0.0.2.dist-info/RECORD,,

otter/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 # get the version
 from ._version import __version__
 

otter/_version.py

@@ -2,4 +2,4 @@
 Just define the package version in one place
 """
 
-__version__ = "0.0.1"
+__version__ = "0.0.2"

otter/exceptions.py

@@ -2,8 +2,14 @@
 Custom exceptions for otter
 """
 
+from __future__ import annotations
+
 
 class FailedQueryError(ValueError):
+    """
+    Exception thrown when the users query does not return any results.
+    """
+
     def __str__(self):
         txt = "You're query/search did not return any results! "
         txt += "Try again with different parameters!"
@@ -11,10 +17,19 @@ class FailedQueryError(ValueError):
 
 
 class IOError(ValueError):
+    """
+    Exception thrown when the input or output argument/value is not the correct type.
+    """
+
     pass
 
 
 class OtterLimitationError(Exception):
+    """
+    Exception thrown when the user requests something that is currently not supported
+    by the API.
+    """
+
     def __init__(self, msg):
         self.msg = "Current Limitation Found: " + msg
 
@@ -23,4 +38,8 @@ class OtterLimitationError(Exception):
 
 
 class TransientMergeError(Exception):
+    """
+    Exception thrown when the Transient objects can not be combined as expected.
+    """
+
     pass

otter/io/otter.py

@@ -2,6 +2,7 @@
 This is the primary class for user interaction with the catalog
 """
 
+from __future__ import annotations
 import os
 import json
 import glob
@@ -28,14 +29,11 @@ class Otter(object):
     This is the primary class for users to access the otter backend database
 
     Args:
-        username [str]: Your connection username to the database, default is the user
-                        login which only has read permission.
-        password [str]: Your password corresponding to your username.
-        db [str]: The database name to connect to. This is default to 'otter' which is
-                  the only database so far.
-        collection [str]: The collection to read data from. Right now the only
-                          collection is 'tdes'.
-        debug [bool]: debug mode, set to true to limit reading from database.
+        datadir (str): Path to the data directory with the otter data. If not provided
+                       will default to a ".otter" directory in the CWD where you call
+                       this class from.
+        debug (bool): If we should just debug and not do anything serious.
+
     """
 
     def __init__(self, datadir: str = None, debug: bool = False) -> None:
@@ -87,9 +85,9 @@ class Otter(object):
         Performs a cone search of the catalog over the given coords and radius.
 
         Args:
-            coords [SkyCoord]: An astropy SkyCoord object with coordinates to match to
-            radius [float]: The radius of the cone in arcseconds, default is 0.05"
-            raw [bool]: If False (the default) return an astropy table of the metadata
+            coords (SkyCoord): An astropy SkyCoord object with coordinates to match to
+            radius (float): The radius of the cone in arcseconds, default is 0.05"
+            raw (bool): If False (the default) return an astropy table of the metadata
                         for matching objects. Otherwise, return the raw json dicts
 
         Return:
@@ -117,35 +115,40 @@ class Otter(object):
         unit conversion for you!
 
         Args:
-            flux_units [astropy.unit.Unit]: Either a valid string to convert
+            flux_units (astropy.unit.Unit): Either a valid string to convert
                                             or an astropy.unit.Unit
-            date_units [astropy.unit.Unit]: Either a valid string to convert to a date
+            date_units (astropy.unit.Unit): Either a valid string to convert to a date
                                             or an astropy.unit.Unit
-            return_type [str]: Either 'astropy' or 'pandas'. If astropy, returns an
+            return_type (str): Either 'astropy' or 'pandas'. If astropy, returns an
                                astropy Table. If pandas, returns a pandas DataFrame.
                                Default is 'astropy'.
-            obs_type [str]: Either 'radio', 'uvoir', or 'xray'. Will only return that
+            obs_type (str): Either 'radio', 'uvoir', or 'xray'. Will only return that
                             type of photometry if not None. Default is None and will
                             return any type of photometry.
-            keep_raw [bool]: If True, keep the raw flux/date/freq/wave associated with
+            keep_raw (bool): If True, keep the raw flux/date/freq/wave associated with
                              the dataset. Else, just keep the converted data. Default
                              is False.
-            **kwargs : Arguments to pass to Otter.query(). Can be:
-                       names [list[str]]: A list of names to get the metadata for
-                       coords [SkyCoord]: An astropy SkyCoord object with coordinates
+            **kwargs : Arguments to pass to Otter.query(). Can be::
+
+                       names (list[str]): A list of names to get the metadata for
+                       coords (SkyCoord): An astropy SkyCoord object with coordinates
                                           to match to
-                       radius [float]: The radius in arcseconds for a cone search,
+                       radius (float): The radius in arcseconds for a cone search,
                                        default is 0.05"
-                       minZ [float]: The minimum redshift to search for
-                       maxZ [float]: The maximum redshift to search for
-                       refs [list[str]]: A list of ads bibcodes to match to. Will only
+                       minZ (float): The minimum redshift to search for
+                       maxZ (float): The maximum redshift to search for
+                       refs (list[str]): A list of ads bibcodes to match to. Will only
                                          return metadata for transients that have this
                                          as a reference.
-                       hasSpec [bool]: if True, only return events that have spectra.
+                       hasSpec (bool): if True, only return events that have spectra.
 
         Return:
-           The photometry for the requested transients that match the arguments.
-           Will be an astropy Table sorted by transient default name.
+            The photometry for the requested transients that match the arguments.
+            Will be an astropy Table sorted by transient default name.
+
+        Raises:
+            FailedQueryError: When the query returns no results
+            IOError: if one of your inputs is incorrect
         """
         queryres = self.query(hasphot=True, **kwargs)
 
@@ -153,16 +156,25 @@ class Otter(object):
         for transient in queryres:
             # clean the photometry
             default_name = transient["name/default_name"]
-            phot = transient.clean_photometry(
-                flux_unit=flux_unit,
-                date_unit=date_unit,
-                wave_unit=wave_unit,
-                freq_unit=freq_unit,
-                obs_type=obs_type,
-            )
-            phot["name"] = [default_name] * len(phot)
 
-            dicts.append(phot)
+            try:
+                phot = transient.clean_photometry(
+                    flux_unit=flux_unit,
+                    date_unit=date_unit,
+                    wave_unit=wave_unit,
+                    freq_unit=freq_unit,
+                    obs_type=obs_type,
+                )
+
+                phot["name"] = [default_name] * len(phot)
+
+                dicts.append(phot)
+
+            except FailedQueryError:
+                # This is fine, it just means that there is no data associated
+                # with this one transient. We'll check and make sure there is data
+                # associated with at least one of the transients later!
+                pass
 
         if len(dicts) == 0:
             raise FailedQueryError()
@@ -203,7 +215,7 @@ class Otter(object):
         Loads an otter JSON file
 
         Args:
-            filename [str]: The path to the file to load
+            filename (str): The path to the OTTER JSON file to load
         """
 
         # read in files from summary
@@ -234,15 +246,15 @@ class Otter(object):
         same units.
 
         Args:
-            names [list[str]]: A list of names to get the metadata for
-            coords [SkyCoord]: An astropy SkyCoord object with coordinates to match to
-            radius [float]: The radius in arcseconds for a cone search, default is 0.05"
-            minz [float]: The minimum redshift to search for
-            maxz [float]: The maximum redshift to search for
-            refs [list[str]]: A list of ads bibcodes to match to. Will only return
+            names (list[str]): A list of names to get the metadata for
+            coords (SkyCoord): An astropy SkyCoord object with coordinates to match to
+            radius (float): The radius in arcseconds for a cone search, default is 0.05"
+            minz (float): The minimum redshift to search for
+            maxz (float): The maximum redshift to search for
+            refs (list[str]): A list of ads bibcodes to match to. Will only return
                               metadata for transients that have this as a reference.
-            hasphot [bool]: if True, only returns transients which have photometry.
-            hasspec [bool]: if True, only return transients that have spectra.
+            hasphot (bool): if True, only returns transients which have photometry.
+            hasspec (bool): if True, only return transients that have spectra.
 
         Return:
            Get all of the raw (unconverted!) data for objects that match the criteria.
@@ -344,24 +356,29 @@ class Otter(object):
 
         return outdata
 
-    def save(self, schema: list[dict], testing=False, **kwargs) -> None:
+    def save(self, schema: list[dict], testing=False) -> None:
         """
         Upload all the data in the given list of schemas.
 
         Args:
-            schema [list[dict]]: A list of json dictionaries
+            schema (list[dict]): A list of json dictionaries
+            testing (bool): Should we just enter test mode? Default is False
+
+        Raises:
+            OtterLimitationError: If some objects in OTTER are within 5" we can't figure
+                                  out which ones to merge with which ones.
         """
 
         if not isinstance(schema, list):
             schema = [schema]
 
         for transient in schema:
-            print(transient["name/default_name"])
-
             # convert the json to a Transient
             if not isinstance(transient, Transient):
                 transient = Transient(transient)
 
+            print(transient["name/default_name"])
+
             coord = transient.get_skycoord()
             res = self.cone_search(coords=coord)
 
@@ -405,8 +422,6 @@ class Otter(object):
             outfilepath = os.path.join(self.DATADIR, todel[0] + ".json")
             if test_mode:
                 print("Renaming the following file for backups: ", outfilepath)
-            else:
-                os.rename(outfilepath, outfilepath + ".backup")
         else:
             if test_mode:
                 print("Don't need to mess with the files at all!")
@@ -429,13 +444,16 @@ class Otter(object):
             print(f"Would write to {outfilepath}")
             # print(out)
 
-    def generate_summary_table(self, save=False):
+    def generate_summary_table(self, save=False) -> pd.DataFrame:
         """
         Generate a summary table for the JSON files in self.DATADIR
 
         args:
-            save [bool]: if True, save the summary file to "summary.csv"
-                         in self.DATADIR. Default is False.
+            save (bool): if True, save the summary file to "summary.csv"
+                         in self.DATADIR. Default is False and is just returned.
+
+        returns:
+            pandas.DataFrame of the summary meta information of the transients
         """
         allfiles = glob.glob(os.path.join(self.DATADIR, "*.json"))
 

otter/io/transient.py

@@ -3,10 +3,12 @@ Class for a transient,
 basically just inherits the dict properties with some overwriting
 """
 
+from __future__ import annotations
 import warnings
 from copy import deepcopy
 import re
 from collections.abc import MutableMapping
+from typing_extensions import Self
 
 import numpy as np
 import pandas as pd
@@ -37,7 +39,9 @@ class Transient(MutableMapping):
         Overwrite the dictionary init
 
         Args:
-            d [dict]: A transient dictionary
+            d (dict): A transient dictionary
+            name (str): The default name of the transient, default is None and it will
+                        be inferred from the input dictionary.
         """
         self.data = d
 
@@ -68,7 +72,7 @@ class Transient(MutableMapping):
         """
 
         if isinstance(keys, (list, tuple)):
-            return Transient({key: self[key] for key in keys})
+            return Transient({key: (self[key] if key in self else []) for key in keys})
         elif isinstance(keys, str) and "/" in keys:  # this is for a path
             s = "']['".join(keys.split("/"))
             s = "['" + s
@@ -85,6 +89,10 @@ class Transient(MutableMapping):
             return self.data[keys]
 
     def __setitem__(self, key, value):
+        """
+        Override set item to work with the '/' syntax
+        """
+
         if isinstance(key, str) and "/" in key:  # this is for a path
             s = "']['".join(key.split("/"))
             s = "['" + s
@@ -109,7 +117,7 @@ class Transient(MutableMapping):
 
     def __repr__(self, html=False):
         if not html:
-            return str(self.data)
+            return f"Transient(\n\tName: {self.default_name},\n\tKeys: {self.keys()}\n)"
         else:
             html = ""
 
@@ -260,14 +268,17 @@ class Transient(MutableMapping):
         # now return out as a Transient Object
         return Transient(out)
 
-    def get_meta(self, keys=None):
+    def get_meta(self, keys=None) -> Self:
         """
         Get the metadata (no photometry or spectra)
 
         This essentially just wraps on __getitem__ but with some checks
 
         Args:
-            keys [list[str]] : list of keys
+            keys (list[str]) : list of keys to get the metadata for from the transient
+
+        Returns:
+            A Transient object of just the meta data
         """
         if keys is None:
             keys = list(self.keys())
@@ -296,9 +307,16 @@ class Transient(MutableMapping):
 
         return self[keys]
 
-    def get_skycoord(self, coord_format="icrs"):
+    def get_skycoord(self, coord_format="icrs") -> SkyCoord:
         """
         Convert the coordinates to an astropy SkyCoord
+
+        Args:
+            coord_format (str): Astropy coordinate format to convert the SkyCoord to
+                                defaults to icrs.
+
+        Returns:
+            Astropy.coordinates.SkyCoord of the default coordinate for the transient
         """
 
         # now we can generate the SkyCoord
@@ -309,9 +327,12 @@ class Transient(MutableMapping):
 
         return coord
 
-    def get_discovery_date(self):
+    def get_discovery_date(self) -> Time:
         """
-        Get the default discovery date
+        Get the default discovery date for this Transient
+
+        Returns:
+            astropy.time.Time of the default discovery date
         """
         key = "date_reference"
         date = self._get_default(key, filt='df["date_type"] == "discovery"')
@@ -322,9 +343,12 @@ class Transient(MutableMapping):
 
         return Time(date["value"], format=f)
 
-    def get_redshift(self):
+    def get_redshift(self) -> float:
         """
-        Get the default redshift
+        Get the default redshift of this Transient
+
+        Returns:
+            Float value of the default redshift
         """
         f = "df['distance_type']=='redshift'"
         default = self._get_default("distance", filt=f)
@@ -390,10 +414,32 @@ class Transient(MutableMapping):
         wave_unit: u.Unit = "nm",
         by: str = "raw",
         obs_type: str = None,
-    ):
+    ) -> pd.DataFrame:
         """
         Ensure the photometry associated with this transient is all in the same
         units/system/etc
+
+        Args:
+            flux_unit (astropy.unit.Unit): The astropy unit or string representation of
+                                           an astropy unit to convert and return the
+                                           flux as.
+            date_unit (str): Valid astropy date format string.
+            freq_unit (astropy.unit.Unit): The astropy unit or string representation of
+                                           an astropy unit to convert and return the
+                                           frequency as.
+            wave_unit (astropy.unit.Unit): The astropy unit or string representation of
+                                           an astropy unit to convert and return the
+                                           wavelength as.
+            by (str): Either 'raw' or 'value'. 'raw' is the default and is highly
+                      recommended! If 'value' is used it may skip some photometry.
+                      See the schema definition to understand this keyword completely
+                      before using it.
+            obs_type (str): "radio", "xray", or "uvoir". If provided, it only returns
+                            data taken within that range of wavelengths/frequencies.
+                            Default is None which will return all of the data.
+
+        Returns:
+            A pandas DataFrame of the cleaned up photometry in the requested units
         """
 
         # check inputs
@@ -429,6 +475,9 @@ class Transient(MutableMapping):
             else:
                 by = "value"
 
+        # skip rows where 'by' is nan
+        df = df[df[by].notna()]
+
         # drop irrelevant obs_types before continuing
         if obs_type is not None:
             valid_obs_types = {"radio", "uvoir", "xray"}

otter/plotter/otter_plotter.py

@@ -6,19 +6,21 @@ Currently supported backends are:
 - plotly
 """
 
+from __future__ import annotations
 import importlib
 
 
 class OtterPlotter:
-    def __init__(self, backend):
-        """
-        Handles the backend for the "plotter" module
+    """
+    Handles the backend for the "plotter" module
 
-        Args:
-            backend [string]: a string of the module name to import and use
-                              as the backend. Currently supported are "matplotlib",
-                              "matplotlib.pyplot", "plotly", and "plotly.graph_objects"
-        """
+    Args:
+        backend (string): a string of the module name to import and use
+                          as the backend. Currently supported are "matplotlib",
+                          "matplotlib.pyplot", "plotly", and "plotly.graph_objects"
+    """
+
+    def __init__(self, backend):
         if backend == "matplotlib.pyplot":
             self.backend = backend
         elif backend == "pyplot.graph_objects":

otter/plotter/plotter.py

@@ -2,6 +2,7 @@
 Some utilities to create common plots for transients that use the OtterPlotter
 """
 
+from __future__ import annotations
 from .otter_plotter import OtterPlotter
 
 
@@ -21,15 +22,15 @@ def plot_light_curve(
     Plot the light curve for the input data
 
     Args:
-        date [float]: MJD dates
-        flux [float]: Flux
-        date_err [float]: optional error on the MJD dates
-        flux_err [float]: optional error on the flux
-        fig [float]: matplotlib fig object, optional. Will be created if not provided.
-        ax [float]: matplitlib axis object, optional. Will be created if not provided.
-        backend [str]: backend for plotting. options: "matplotlib" (default) or "plotly"
-        xlabel [str]: x-axis label
-        ylabel [str]: y-axis label
+        date (float): MJD dates
+        flux (float): Flux
+        date_err (float): optional error on the MJD dates
+        flux_err (float): optional error on the flux
+        fig (float): matplotlib fig object, optional. Will be created if not provided.
+        ax (float): matplitlib axis object, optional. Will be created if not provided.
+        backend (str): backend for plotting. options: "matplotlib" (default) or "plotly"
+        xlabel (str): x-axis label
+        ylabel (str): y-axis label
         **kwargs: keyword arguments to pass to either plotly.graph_objects.add_scatter
                   or matplotlib.pyplot.errorbar
 
@@ -66,15 +67,15 @@ def plot_sed(
     Plot the SED for the input data
 
     Args:
-        wave_or_freq [float]: wave or frequency array
-        flux [float]: Flux
-        wave_or_freq_err [float]: optional error on the MJD dates
-        flux_err [float]: optional error on the flux
-        fig [float]: matplotlib fig object, optional. Will be created if not provided.
-        ax [float]: matplitlib axis object, optional. Will be created if not provided.
-        backend [str]: backend for plotting. Options: "matplotlib" (default) or "plotly"
-        xlabel [str]: x-axis label
-        ylabel [str]: y-axis label
+        wave_or_freq (float): wave or frequency array
+        flux (float): Flux
+        wave_or_freq_err (float): optional error on the MJD dates
+        flux_err (float): optional error on the flux
+        fig (float): matplotlib fig object, optional. Will be created if not provided.
+        ax (float): matplitlib axis object, optional. Will be created if not provided.
+        backend (str): backend for plotting. Options: "matplotlib" (default) or "plotly"
+        xlabel (str): x-axis label
+        ylabel (str): y-axis label
         **kwargs: keyword arguments to pass to either plotly.graph_objects.add_scatter
                   or matplotlib.pyplot.errorbar
 

otter/util.py

@@ -2,6 +2,7 @@
 Some constants, mappings, and functions to be used across the software
 """
 
+from __future__ import annotations
 import os
 import ads
 import astropy.units as u
@@ -187,6 +188,10 @@ FILTER_MAP_WAVE = {
     "F2100W": 20842.526633138932,
     "F2550W": 25408.228367890282,
 }
+"""
+Mapping for the effective wavelength in nanometers for all filters used in the dataset.
+"""
+
 
 # gives the effective frequency for all filters
 # These are all in THz
@@ -302,6 +307,10 @@ FILTER_MAP_FREQ = {
     "F2100W": 14.581938602646188,
     "F2550W": 11.919267708332558,
 }
+"""
+Mapping for the effective frequencies in THz for all the filters used in OTTER
+"""
+
 
 # x-ray telescope areas for converting
 # NOTE: these are estimates from the links provided
@@ -319,10 +328,27 @@ XRAY_AREAS = {
     # https://cxc.harvard.edu/cdo/about_chandra
     "chandra": 600 * u.cm**2,
 }
+"""
+X-Ray telescope areas that are used for converting from counts to other units.
+
+NOTE: These are estimates from the following links
+* https://swift.gsfc.nasa.gov/about_swift/Sci_Fact_Sheet.pdf
+* https://heasarc.gsfc.nasa.gov/docs/rosat/ruh/handbook/node39.html#SECTION00634000000000000000
+* https://www.cosmos.esa.int/web/xmm-newton/technical-details-mirrors
+* https://cxc.harvard.edu/cdo/about_chandra
+"""
+
 
 # define a working base directory constant
 BASEDIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+"""
+Base directory for the OTTER API software package
+"""
+
 DATADIR = os.path.join(BASEDIR, "data", "base")
+"""
+Deprecated database directory that IS NOT always constant anymore
+"""
 
 # Overarching schema that stops once we get down to a string or list
 schema = {
@@ -337,10 +363,16 @@ schema = {
     "spectra": [],
     "filter_alias": [],
 }
-
+"""
+Schema dictionary to be filled with values from the subschemas
+"""
 
 # sub schemas that get filled into lists
 name_alias_schema = {"value": None, "reference": None}
+"""
+Subschema for the name and alias dictionary
+"""
+
 coordinate_schema = {
     "ra": None,
     "dec": None,
@@ -367,6 +399,10 @@ coordinate_schema = {
     "reference": None,
     "default": None,
 }
+"""
+Subschema to describe the possible attributes for the coordinate dictionary
+"""
+
 
 distance_schema = {
     "value": None,
@@ -379,6 +415,10 @@ distance_schema = {
     "default": None,
     "distance_type": None,
 }
+"""
+Subschema to describe the possible attributes for the distance dictionary
+"""
+
 
 classification_schema = {
     "object_class": None,
@@ -387,8 +427,14 @@ classification_schema = {
     "reference": None,
     "default": None,
 }
+"""
+Subschema to describe the attributes for the classification dictionary
+"""
 
 reference_alias_schema = {"name": None, "human_readable_name": None}
+"""
+Subschema to describe the attributes for the reference alias dictionary
+"""
 
 date_reference_schema = {
     "value": None,
@@ -397,6 +443,9 @@ date_reference_schema = {
     "reference": None,
     "computed": None,
 }
+"""
+Subschema to describe the date_reference dictionary attributes
+"""
 
 photometry_schema = {
     "raw": None,
@@ -436,6 +485,10 @@ photometry_schema = {
     "val_host": None,
     "val_hostav": None,
 }
+"""
+Subschema to describe all of the possible attributes that can be used in the photometry
+dictionary
+"""
 
 spectra_schema = {
     "wavelength": None,
@@ -495,6 +548,9 @@ filter_alias_schema = {
     "zp_units": None,
     "zp_system": None,
 }
+"""
+Subschema to describe the attributes in the filter_alias dictionary
+"""
 
 # package the subschemas by the key used for that location in the Transient object
 subschema = {
@@ -508,3 +564,6 @@ subschema = {
     "spectra": spectra_schema,
     "filter_alias": filter_alias_schema,
 }
+"""
+A useful variable to describe all of the subschemas that are available and can be used
+"""

astro_otter-0.0.1.dist-info/RECORD

@@ -1,15 +0,0 @@
-otter/__init__.py,sha256=llO9sEPh8xa_dH2W0nlp6eaINvOFmxdThUMfnRLvTlg,339
-otter/_version.py,sha256=IF3Dl1lgaRSZdnbDGaVgT-Wp8FNX0rjz37C1iwLyXlU,76
-otter/exceptions.py,sha256=jaNg0fw5WBWlIRLG0aE5xKJvpIg8JAEDqQ7orwkStq4,494
-otter/util.py,sha256=rnzyNWwjrBLsZIbKi33o1Ly-HbTeAMaUT5E8N313RiY,13600
-otter/io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-otter/io/otter.py,sha256=S1DaOFg3DtPPyNzrvOg7_QG8fps_6m-w-usINJ6X2gk,17038
-otter/io/transient.py,sha256=vMyaYjlc2SKn9gWII8wrpJRe3NyZViXGMiZ9Pv_voNo,31165
-otter/plotter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-otter/plotter/otter_plotter.py,sha256=WbnzNUR_pE3d2tJcH3K2pxJvl-r6OUUOZ0kWb35FlQE,2083
-otter/plotter/plotter.py,sha256=QeAQXgeJ9O429Khin9dCT2tXvcjxUzc_HLU74LbRw6g,2861
-astro_otter-0.0.1.dist-info/LICENSE,sha256=s9IPE8A3CAMEaZpDhj4eaorpmfLYGB0mIGphq301PUY,1067
-astro_otter-0.0.1.dist-info/METADATA,sha256=KM1FpQrYPArikJMNzmNCYshN6PzJGrYCp4UCTkM3TOw,31847
-astro_otter-0.0.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-astro_otter-0.0.1.dist-info/top_level.txt,sha256=Wth72sCwBRUk3KZGknSKvLQDMFuJk6qiaAavMDOdG5k,6
-astro_otter-0.0.1.dist-info/RECORD,,