pyExtinction 2.0__py3-none-any.whl

pyextinction/__init__.py

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: 2013-present Yannick Copin <y.copin@ip2i.in2p3.fr>
+# SPDX-License-Identifier: CECILL-C
+
+"""pyExtinction initialization."""
+
+__version__ = '2.0'
+__author__ = "Yannick Copin <y.copin@ip2i.in2p3.fr>, " \
+             "Clément Buton <c.buton@araiko.ai>"
+
+__all__ = ['atmospheric_extinction']
+for _mod in __all__:
+    __import__(__name__ + "." + _mod, fromlist=[None])

pyextinction/__main__.py

@@ -0,0 +1,206 @@
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: 2013-present Yannick Copin <y.copin@ip2i.in2p3.fr>
+# SPDX-License-Identifier: CECILL-C
+
+import argparse
+import os
+import numpy as np
+import matplotlib.pyplot as plt
+
+from pyextinction import __version__
+from pyextinction.atmospheric_extinction import ExtinctionModel, O3Template
+
+def main():
+
+    # Options =================================================================
+
+    description = """\
+Compute and/or plot atmospheric extinction from physical parameters,
+as described in Buton et al. (2013A&A...549A...8B), *Atmospheric
+extinction properties above Mauna Kea from the Nearby Supernova
+Factory spectro-photometric data set*.
+
+Default extinction parameters correspond to mean Mauna-Kea summit
+conditions. Each extinction parameter can be specified using option
+'--param value stderr'.
+"""
+
+    epilog = """\
+
+If you have found this software useful for your research, we would
+appreciate a reference to *the atmospheric extinction of Buton et
+al. (2013)*.
+"""
+
+    parser = argparse.ArgumentParser(
+        description=description,
+        epilog=epilog,
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=__version__,
+    )
+
+    # Rayleigh parameters ------------------------------------------------------
+
+    rayleigh = parser.add_argument_group("Rayleigh parameters")
+
+    rayleigh.add_argument(
+        "-p",
+        "--pressure",
+        type=float,
+        nargs=2,
+        default=(616.0, 2.0),
+        metavar=("PRESSURE", "STDERR"),
+        help="Surface pressure [%(default)s mbar]",
+    )
+
+    # Ozone parameters ---------------------------------------------------------
+
+    ozone = parser.add_argument_group("Ozone parameters")
+
+    ozone.add_argument(
+        "-t",
+        "--o3template",
+        metavar="FILE.fits",
+        default=O3Template,
+        help="Ozone transmission template [%(default)s]",
+    )
+
+    ozone.add_argument(
+        "-c",
+        "--o3column",
+        type=float,
+        nargs=2,
+        default=(257.0, 23.0),
+        metavar=("COLUMN", "STDERR"),
+        help="Ozone column density [%(default)s DU]",
+    )
+
+    # Aerosol parameters -------------------------------------------------------
+
+    aerosols = parser.add_argument_group("Aerosol parameters")
+
+    aerosols.add_argument(
+        "-d",
+        "--depth",
+        type=float,
+        nargs=2,
+        default=(7.6e-3, 1.4e-3),
+        metavar=("DEPTH", "STDERR"),
+        help="Aerosol optical depth at 1 micron [%(default)s]",
+    )
+
+    aerosols.add_argument(
+        "-a",
+        "--angstrom",
+        type=float,
+        nargs=2,
+        default=(1.26, 1.33),
+        metavar=("EXPONENT", "STDERR"),
+        help="Aerosol Angstrom exponent [%(default)s]",
+    )
+
+    # Output parameters --------------------------------------------------------
+
+    outputs = parser.add_argument_group("Output parameters")
+
+    outputs.add_argument(
+        "-w",
+        "--wrange",
+        type=float,
+        nargs=3,
+        default=(3200.0, 10001.0, 10.0),
+        metavar=("START", "END", "STEP"),
+        help="Wavelength range [%(default)s Å]",
+    )
+
+    outputs.add_argument(
+        "-o",
+        "--output",
+        metavar="FILE.txt|fits",
+        default="atmosphericExtinction.txt",
+        help="Output table name (.txt or .fits) [%(default)s]",
+    )
+
+    outputs.add_argument(
+        "-P",
+        "--plot",
+        action="store_true",
+        help="Interactive plot",
+    )
+
+    outputs.add_argument(
+        "-T",
+        "--transmission",
+        action="store_true",
+        help="Plot transmission rather than extinction",
+    )
+
+    # Check for options consistency ============================================
+
+    args = parser.parse_args()
+
+    # Wavelength range
+    w_start, w_end, w_step = args.wrange
+
+    if w_start > w_end or w_step > (w_end - w_start):
+        parser.error(
+            f"Invalid wavelength range '--wrange {','.join(map(str, args.wrange))}'.")
+
+    # Output
+    if args.output:
+        _, outformat = os.path.splitext(args.output)
+        if outformat.lower() not in (".fits", ".txt"):
+            parser.error(f"Unknown output format {outformat!r}.")
+
+        outformat = outformat[1:].lower()
+
+    # ==========================================================================
+
+    # Input parameters ---------------------------------------------------------
+
+    # Wavelength domain
+    lbda = np.arange(w_start, w_end, w_step, dtype=float)
+
+    # Extinction parameters
+    o3, do3 = args.o3column
+    ang, dang = args.angstrom
+    tau, dtau = args.depth
+    p, dp = args.pressure
+
+    # Extinction model ----------------------------------------------------------
+
+    ext_model = ExtinctionModel(lbda, args.o3template)
+
+    ext = ext_model.extinction(
+        [p, o3, tau, ang],
+        [dp, do3, dtau, dang],
+        components=True,
+    )
+
+    print(ext_model)
+
+    # Create output tables -----------------------------------------------------
+
+    if args.output:
+        print(f"Saving extinction table {args.output!r}...")
+        ext_model.write(args.output, ext, outformat)
+
+    # Create output graphics ---------------------------------------------------
+
+    if args.plot:
+        print("Generating interactive figure...")
+
+        ax = ext_model.plot(
+            ext,
+            components=True,
+            transmission=args.transmission,
+        )
+
+        plt.show()
+
+    print(epilog)

pyextinction/__main__.py.bak

@@ -0,0 +1,141 @@
+#!/usr/bin/env python
+
+import os
+import numpy as np
+from .pyextinction import O3Template, ExtinctionModel
+
+import optparse
+
+# Options =================================================================
+
+usage = "usage: %prog [options]"
+
+description = """\
+Compute and/or plot atmospheric extinction from physical parameters,
+as described in Buton et al. (2013A&A...549A...8B), *Atmospheric
+extinction properties above Mauna Kea from the Nearby Supernova
+Factory spectro-photometric data set*.
+
+Default extinction parameters correspond to mean Mauna-Kea summit
+conditions.  Each extinction parameter can be specified using option
+'--param value stderr'.
+"""
+epilog = """\
+If you have found this software useful for your research, we would
+appreciate a reference to *the atmospheric extinction of Buton et
+al. (2013)*."""
+
+parser = optparse.OptionParser(usage, version=__version__,
+                               description=description,
+                               epilog=epilog)
+
+# Rayleigh parameters ------------------------------
+
+rayleigh = optparse.OptionGroup(parser, "Rayleigh parameters")
+
+rayleigh.add_option('-p', '--pressure', type=float, nargs=2,
+                    help="Surface pressure [%default mbar]",
+                    default=(616., 2.))
+
+parser.add_option_group(rayleigh)
+
+# Ozone parameters ------------------------------
+
+ozone = optparse.OptionGroup(parser, "Ozone parameters")
+
+ozone.add_option('-t', '--o3template', metavar='FILE.fits',
+                 help="Ozone transmission template",
+                 default=O3Template)
+ozone.add_option('-c', '--o3column', type=float, nargs=2,
+                 help="Ozone column density [%default DU]",
+                 default=(257., 23.))
+
+parser.add_option_group(ozone)
+
+# Aerosol parameters ------------------------------
+
+aerosols = optparse.OptionGroup(parser, "Aerosol parameters")
+
+aerosols.add_option('-d', '--depth', type=float, nargs=2,
+                    help="Aerosol optical depth at 1 micron [%default]",
+                    default=(7.6e-3, 1.4e-3))
+aerosols.add_option('-a', '--angstrom', type=float, nargs=2,
+                    help="Aerosol Angstrom exponent [%default]",
+                    default=(1.26, 1.33))
+
+parser.add_option_group(aerosols)
+
+# Output ------------------------------
+
+outputs = optparse.OptionGroup(parser, "Output parameters")
+
+outputs.add_option('-w', '--wrange', metavar='START,END,STEP',
+                   type=float, nargs=3,
+                   help="Wavelength range [%default A]",
+                   default=(3200, 10001, 10))
+
+outputs.add_option('-o', '--output', metavar="FILE.txt|fits",
+                   help="Output table name (.txt|.fits)",
+                   default="atmosphericExtinction.txt")
+
+outputs.add_option("-P", "--plot", action='store_true',
+                   help="Interactive plot")
+outputs.add_option("-T", "--transmission", action='store_true',
+                   help="Plot transmission rather than extinction")
+
+parser.add_option_group(outputs)
+
+# Check for options consistency ============================================
+
+opts, args = parser.parse_args()
+
+# Wavelength range
+wStart, wEnd, wStep = opts.wrange
+if (wStart > wEnd) or (wStep > (wEnd - wStart)):
+    parser.error("Invalid wavelength range '--wrange %s'" %
+                 (','.join(opts.wrange)))
+
+# Output
+if opts.output:                     # Decipher output format
+    basename, outformat = os.path.splitext(opts.output)
+    if outformat.lower() not in ('.fits', '.txt'):
+        parser.error("Unknown output format '%s'" % outformat)
+    outformat = outformat[1:].lower()  # Remove leading dot
+
+# ==========================================================================
+
+# Inputs parameters ------------------------------
+
+# Wavelength domain
+lbda = np.arange(wStart, wEnd, wStep, dtype=float)
+
+# Extinction parameters
+o3, do3 = opts.o3column     # Ozone column density [DU]
+ang, dang = opts.angstrom   # Ångström exponent
+tau, dtau = opts.depth      # Aerosol optical depth at ref. wavelength
+p, dp = opts.pressure       # Surface pressure [mbar]
+
+# Extinction model ------------------------------
+
+extModel = ExtinctionModel(lbda, opts.o3template)
+ext = extModel.extinction([ p, o3, tau, ang],
+                          [dp, do3, dtau, dang], components=True)
+desc = str(extModel)
+print desc
+
+# Create output tables ------------------------------
+
+if opts.output:
+    print "Saving extinction table '%s'..." % opts.output
+    extModel.write(opts.output, ext, outformat)
+
+# Create output graphics ------------------------------
+
+if opts.plot:
+    print "Generating interactive figure..."
+    import matplotlib.pyplot as P
+
+    ax = extModel.plot(ext, components=True, transmission=opts.transmission)
+    P.show()
+
+print epilog