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

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,48 @@ 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
+"""
+
+VIZIER_LARGE_CATALOGS = [
+    "2MASS-PSC",
+    "2MASX",
+    "AC2000.2",
+    "AKARI",
+    "ALLWISE",
+    "ASCC-2.5",
+    "B/DENIS",
+    "CMC14",
+    "Gaia-DR1",
+    "GALEX",
+    "GLIMPSE",
+    "GSC-ACT",
+    "GSC1.2",
+    "GSC2.2",
+    "GSC2.3",
+    "HIP",
+    "HIP2",
+    "IRAS",
+    "NOMAD1",
+    "NVSS",
+    "PanSTARRS-DR1",
+    "PGC",
+    "Planck-DR1",
+    "PPMX",
+    "PPMXL",
+    "SDSS-DR12",
+    "SDSS-DR7",
+    "SDSS-DR9",
+    "Tycho-2",
+    "UCAC2",
+    "UCAC3",
+    "UCAC4",
+    "UKIDSS",
+    "USNO-A2",
+    "USNO-B1",
+    "WISE",
+]
+"""
+ViZier catalog names that we query for host information in the Host class
+"""