mlso-instruments 0.0.1__py3-none-any.whl

mlso/instruments/__init__.py

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+"""This package contains library of utilities for handling data from MLSO
+instruments.
+"""
+
+import importlib.metadata
+
+__version__ = importlib.metadata.version("mlso-instruments")

mlso/instruments/kcor.py

@@ -0,0 +1 @@
+# encoding: utf-8

mlso/instruments/ucomp.py

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+import astropy.io.fits as fits
+
+
+def display_hdu(hdu: fits.hdu.image.ImageHDU):
+    """Display an extension of a UCoMP file.
+    """
+    pass
+
+
+def display(filename: str, extension=None):
+    """Display an extension of a UCoMP file.
+    """
+    with fits.open(filename) as file:
+        # [TODO]: if needed, identify file type to get default extension
+        display_hdu(file[extension])

mlso_instruments-0.0.1.dist-info/METADATA

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: mlso-instruments
+Version: 0.0.1
+Summary: Python package providing a library of utlities for Mauna Loa Solar Observatory (MLSO) instruments
+Author: Michael Galloy
+Author-email: Michael Galloy <mgalloy@ucar.edu>
+Maintainer: Michael Galloy
+Maintainer-email: Michael Galloy <mgalloy@ucar.edu>
+License-Expression: MIT
+Project-URL: homepage, https://www2.hao.ucar.edu/mlso
+Project-URL: repository, https://github.com/NCAR/mlso-instruments
+Project-URL: documentation, https://mlso-instruments.readthedocs.io/en/latest/
+Project-URL: issues, https://github.com/NCAR/mlso-instruments/issues
+Project-URL: changelog, https://github.com/NCAR/mlso-instruments/blob/master/CHANGELOG.md
+Keywords: Mauna Loa Solar Observatory,MLSO,solar
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: astropy
+Requires-Dist: numpy
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: tox; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: watchdog; extra == "dev"
+Requires-Dist: Sphinx; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: pytest-runner; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: sphinx_rtd_theme; extra == "dev"
+Requires-Dist: myst-parser; extra == "dev"
+Dynamic: license-file
+
+# mlso-instruments
+
+This package contains Python utilities for analyzing and displaying data from
+instruments at the Mauna Loa Solar Observatory (MLSO)
+
+[![Read the Docs](https://app.readthedocs.org/projects/mlso-instruments/badge/?version=latest)](https://mlso-instruments.readthedocs.io/en/latest/)
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/NCAR/mlso-instruments/tree/main.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/NCAR/mlso-instruments/tree/main)
+[![Version](https://img.shields.io/pypi/v/mlso-instruments.svg)](https://pypi.org/project/mlso-instruments/)
+![Status](https://img.shields.io/pypi/status/mlso-instruments.svg)
+
+## Installation
+
+### Installing from PyPI
+
+The easiest way to install the MLSO API client is via the released versions on
+PyPI. This is the recommended method for most users.
+
+```console
+pip install mlso-instruments
+```
+
+If you want to upgrade an existing installation, do:
+
+```console
+pip install -U mlso-instruments
+```
+
+### Installing from source
+
+The source code can be found on the [repo's GitHub page]. Use git or download
+a ZIP file with contents of the source.
+
+[repo's GitHub page]: https://github.com/NCAR/mlso-instruments
+
+Once you have the source code, install the Python portion of the package:
+
+```console
+cd mlso-instruments
+pip install .
+```
+
+If you intend to make changes to the code, install the dev requirements and
+allow changes to the code to automatically be used:
+
+```console
+pip install -e .[dev]
+```
+
+## Usage
+
+See the [documentation] for help on using the package, including the API
+Endpoints, the bindings for Python and IDL, and the command-line interface.
+
+[documentation]: https://mlso-instruments.readthedocs.io/en/latest/index.html

mlso_instruments-0.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+mlso/instruments/__init__.py,sha256=XFxKPa0Ki-kZ1czS5QpdOQQ_bIrAzh4oIl8xM5UW0f4,199
+mlso/instruments/kcor.py,sha256=E2bdssT0GmZweJjZ-4N1cav440TE__rUvQLR3jARan8,18
+mlso/instruments/ucomp.py,sha256=o0Ky8IpPChCfhOBFqDyNRDP6hMIRfgSK9ACesZzjZ7Y,408
+mlso_instruments-0.0.1.dist-info/licenses/LICENSE,sha256=Uky6fiiVw7cakFVRtVpzg-mvqOQ-WcA_H8lHqhPRg58,1101
+mlso_instruments-0.0.1.dist-info/METADATA,sha256=MO1Smn94MtSYT1HlIFr2hv5ciKvPblqlxg9KfjlBzW4,3482
+mlso_instruments-0.0.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+mlso_instruments-0.0.1.dist-info/top_level.txt,sha256=oenBdn5KKGUSTCJaHuHJ8xsNqkhg2lwpM63JJtY-prs,5
+mlso_instruments-0.0.1.dist-info/RECORD,,

mlso_instruments-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mlso_instruments-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 NSF National Center for Atmospheric Research
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mlso_instruments-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+mlso