imap-processing 0.8.0__tar.gz → 0.13.0__tar.gz

imap_processing-0.13.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.1
+Name: imap-processing
+Version: 0.13.0
+Summary: IMAP Science Operations Center Processing
+License: MIT
+Keywords: IMAP,SDC,SOC,Science Operations
+Author: IMAP SDC Developers
+Author-email: imap-sdc@lists.lasp.colorado.edu
+Requires-Python: >=3.10,<4
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development
+Provides-Extra: dev
+Provides-Extra: doc
+Provides-Extra: map-visualization
+Provides-Extra: test
+Provides-Extra: tools
+Requires-Dist: astropy-healpix (>=1.0)
+Requires-Dist: cdflib (>=1.3.1,<2.0.0)
+Requires-Dist: healpy (>=1.18.0,<2.0.0) ; extra == "map-visualization"
+Requires-Dist: imap-data-access (>=0.21.0)
+Requires-Dist: mypy (==1.10.1) ; extra == "dev"
+Requires-Dist: netcdf4 (>=1.7.2,<2.0.0) ; extra == "test"
+Requires-Dist: numpy (<=3)
+Requires-Dist: numpydoc (>=1.5.0,<2.0.0) ; extra == "doc"
+Requires-Dist: openpyxl (>=3.0.7) ; extra == "test" or extra == "tools"
+Requires-Dist: pandas (>=2.0.0) ; extra == "tools"
+Requires-Dist: pre-commit (>=3.3.3,<4.0.0) ; extra == "dev"
+Requires-Dist: pydata-sphinx-theme ; extra == "doc"
+Requires-Dist: pytest (>=6.2.5) ; extra == "test"
+Requires-Dist: pytest-cov (>=4.0.0,<5.0.0) ; extra == "test"
+Requires-Dist: pytest-xdist (>=3.2,<4.0) ; extra == "test"
+Requires-Dist: requests (>=2.32.3,<3.0.0) ; extra == "test"
+Requires-Dist: ruff (==0.2.1) ; extra == "dev"
+Requires-Dist: sammi-cdf (>=1.0,<2.0)
+Requires-Dist: scipy (>=1.13,<2.0)
+Requires-Dist: space_packet_parser (>=5.0.1,<6.0.0)
+Requires-Dist: sphinx ; extra == "doc"
+Requires-Dist: sphinxcontrib-openapi (>=0.8.3,<0.9.0) ; extra == "doc"
+Requires-Dist: spiceypy (>=6.0.0)
+Requires-Dist: xarray (>=2024.10.0)
+Description-Content-Type: text/markdown
+
+# IMAP (Interstellar Mapping and Acceleration Probe)
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+[![readthedocs](https://readthedocs.org/projects/imap-processing/badge/?version=latest)](https://imap-processing.readthedocs.io/en/latest/)
+<!-- DOI-BADGE -->
+[![DOI](https://zenodo.org/badge/654679818.svg)](https://zenodo.org/badge/latestdoi/654679818)
+
+The Interstellar Mapping and Acceleration Probe (IMAP) is an exciting project aimed at studying the interstellar medium and investigating the acceleration mechanisms of particles within our galaxy. IMAP utilizes cutting-edge technology and advanced instrumentation to gather valuable data and expand our understanding of space.
+
+The IMAP project's Git repository serves as a centralized hub for collaboration among researchers, scientists, and developers involved in the project. It provides a platform for version control, code sharing, issue tracking, and documentation, fostering a collaborative environment for advancing the goals of the IMAP mission.
+
+Through the Git repository, contributors can access project resources, explore the codebase, propose enhancements or bug fixes, and participate in discussions with other team members. This collaborative approach promotes efficient development and fosters innovation in the pursuit of interstellar mapping and particle acceleration research.
+
+Join the IMAP Git repository to be part of an exciting scientific endeavor, contribute your expertise, and help unlock the mysteries of the interstellar medium and particle acceleration in our galaxy. Together, we can advance our knowledge of the cosmos and pave the way for future discoveries in space exploration.
+
+[IMAP Website](https://imap.princeton.edu/)
+
+[IMAP Processing Documentation](https://imap-processing.readthedocs.io/en/latest/)
+
+[Getting started](https://imap-processing.readthedocs.io/en/latest/development-guide/getting-started.html)
+
+# Credits
+[LASP (Laboratory of Atmospheric and Space Physics)](https://lasp.colorado.edu/)
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="http://greglucas.github.io"><img src="https://avatars.githubusercontent.com/u/12417828?v=4?s=100" width="100px;" alt="Greg Lucas"/><br /><sub><b>Greg Lucas</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/tech3371"><img src="https://avatars.githubusercontent.com/u/36522642?v=4?s=100" width="100px;" alt="Tenzin Choedon"/><br /><sub><b>Tenzin Choedon</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/laspsandoval"><img src="https://avatars.githubusercontent.com/u/46567335?v=4?s=100" width="100px;" alt="Laura Sandoval"/><br /><sub><b>Laura Sandoval</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/sdhoyt"><img src="https://avatars.githubusercontent.com/u/7146374?v=4?s=100" width="100px;" alt="Sean Hoyt"/><br /><sub><b>Sean Hoyt</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/GFMoraga"><img src="https://avatars.githubusercontent.com/u/104743000?v=4?s=100" width="100px;" alt="Gabriel Moraga"/><br /><sub><b>Gabriel Moraga</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/bourque"><img src="https://avatars.githubusercontent.com/u/2250769?v=4?s=100" width="100px;" alt="Matthew Bourque"/><br /><sub><b>Matthew Bourque</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/maxinelasp"><img src="https://avatars.githubusercontent.com/u/117409426?v=4?s=100" width="100px;" alt="Maxine Hartnett"/><br /><sub><b>Maxine Hartnett</b></sub></a><br /></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/bryan-harter"><img src="https://avatars.githubusercontent.com/u/41062454?v=4?s=100" width="100px;" alt="Bryan Harter"/><br /><sub><b>Bryan Harter</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/mstrumik"><img src="https://avatars.githubusercontent.com/u/142874888?v=4?s=100" width="100px;" alt="Marek Strumik"/><br /><sub><b>Marek Strumik</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/vmartinez-cu"><img src="https://avatars.githubusercontent.com/u/39746325?v=4?s=100" width="100px;" alt="Veronica Martinez"/><br /><sub><b>Veronica Martinez</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/subagonsouth"><img src="https://avatars.githubusercontent.com/u/16110870?v=4?s=100" width="100px;" alt="Tim Plummer"/><br /><sub><b>Tim Plummer</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/daralynnrhode"><img src="https://avatars.githubusercontent.com/u/143308810?v=4?s=100" width="100px;" alt="Daralynn Rhode"/><br /><sub><b>Daralynn Rhode</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/anamanica"><img src="https://avatars.githubusercontent.com/u/171708990?v=4?s=100" width="100px;" alt="Ana Manica"/><br /><sub><b>Ana Manica</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/lacoak21"><img src="https://avatars.githubusercontent.com/u/48064300?v=4?s=100" width="100px;" alt="Luisa Coakley"/><br /><sub><b>Luisa Coakley</b></sub></a><br /></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/nkerman"><img src="https://avatars.githubusercontent.com/u/13221946?v=4?s=100" width="100px;" alt="Nat Kerman"/><br /><sub><b>Nat Kerman</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/torimarbois"><img src="https://avatars.githubusercontent.com/u/65727848?v=4?s=100" width="100px;" alt="Tori Marbois"/><br /><sub><b>Tori Marbois</b></sub></a><br /></td>
+</tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+

imap_processing-0.13.0/README.md

@@ -0,0 +1,64 @@
+# IMAP (Interstellar Mapping and Acceleration Probe)
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+[![readthedocs](https://readthedocs.org/projects/imap-processing/badge/?version=latest)](https://imap-processing.readthedocs.io/en/latest/)
+<!-- DOI-BADGE -->
+[![DOI](https://zenodo.org/badge/654679818.svg)](https://zenodo.org/badge/latestdoi/654679818)
+
+The Interstellar Mapping and Acceleration Probe (IMAP) is an exciting project aimed at studying the interstellar medium and investigating the acceleration mechanisms of particles within our galaxy. IMAP utilizes cutting-edge technology and advanced instrumentation to gather valuable data and expand our understanding of space.
+
+The IMAP project's Git repository serves as a centralized hub for collaboration among researchers, scientists, and developers involved in the project. It provides a platform for version control, code sharing, issue tracking, and documentation, fostering a collaborative environment for advancing the goals of the IMAP mission.
+
+Through the Git repository, contributors can access project resources, explore the codebase, propose enhancements or bug fixes, and participate in discussions with other team members. This collaborative approach promotes efficient development and fosters innovation in the pursuit of interstellar mapping and particle acceleration research.
+
+Join the IMAP Git repository to be part of an exciting scientific endeavor, contribute your expertise, and help unlock the mysteries of the interstellar medium and particle acceleration in our galaxy. Together, we can advance our knowledge of the cosmos and pave the way for future discoveries in space exploration.
+
+[IMAP Website](https://imap.princeton.edu/)
+
+[IMAP Processing Documentation](https://imap-processing.readthedocs.io/en/latest/)
+
+[Getting started](https://imap-processing.readthedocs.io/en/latest/development-guide/getting-started.html)
+
+# Credits
+[LASP (Laboratory of Atmospheric and Space Physics)](https://lasp.colorado.edu/)
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="http://greglucas.github.io"><img src="https://avatars.githubusercontent.com/u/12417828?v=4?s=100" width="100px;" alt="Greg Lucas"/><br /><sub><b>Greg Lucas</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/tech3371"><img src="https://avatars.githubusercontent.com/u/36522642?v=4?s=100" width="100px;" alt="Tenzin Choedon"/><br /><sub><b>Tenzin Choedon</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/laspsandoval"><img src="https://avatars.githubusercontent.com/u/46567335?v=4?s=100" width="100px;" alt="Laura Sandoval"/><br /><sub><b>Laura Sandoval</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/sdhoyt"><img src="https://avatars.githubusercontent.com/u/7146374?v=4?s=100" width="100px;" alt="Sean Hoyt"/><br /><sub><b>Sean Hoyt</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/GFMoraga"><img src="https://avatars.githubusercontent.com/u/104743000?v=4?s=100" width="100px;" alt="Gabriel Moraga"/><br /><sub><b>Gabriel Moraga</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/bourque"><img src="https://avatars.githubusercontent.com/u/2250769?v=4?s=100" width="100px;" alt="Matthew Bourque"/><br /><sub><b>Matthew Bourque</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/maxinelasp"><img src="https://avatars.githubusercontent.com/u/117409426?v=4?s=100" width="100px;" alt="Maxine Hartnett"/><br /><sub><b>Maxine Hartnett</b></sub></a><br /></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/bryan-harter"><img src="https://avatars.githubusercontent.com/u/41062454?v=4?s=100" width="100px;" alt="Bryan Harter"/><br /><sub><b>Bryan Harter</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/mstrumik"><img src="https://avatars.githubusercontent.com/u/142874888?v=4?s=100" width="100px;" alt="Marek Strumik"/><br /><sub><b>Marek Strumik</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/vmartinez-cu"><img src="https://avatars.githubusercontent.com/u/39746325?v=4?s=100" width="100px;" alt="Veronica Martinez"/><br /><sub><b>Veronica Martinez</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/subagonsouth"><img src="https://avatars.githubusercontent.com/u/16110870?v=4?s=100" width="100px;" alt="Tim Plummer"/><br /><sub><b>Tim Plummer</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/daralynnrhode"><img src="https://avatars.githubusercontent.com/u/143308810?v=4?s=100" width="100px;" alt="Daralynn Rhode"/><br /><sub><b>Daralynn Rhode</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/anamanica"><img src="https://avatars.githubusercontent.com/u/171708990?v=4?s=100" width="100px;" alt="Ana Manica"/><br /><sub><b>Ana Manica</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/lacoak21"><img src="https://avatars.githubusercontent.com/u/48064300?v=4?s=100" width="100px;" alt="Luisa Coakley"/><br /><sub><b>Luisa Coakley</b></sub></a><br /></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/nkerman"><img src="https://avatars.githubusercontent.com/u/13221946?v=4?s=100" width="100px;" alt="Nat Kerman"/><br /><sub><b>Nat Kerman</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/torimarbois"><img src="https://avatars.githubusercontent.com/u/65727848?v=4?s=100" width="100px;" alt="Tori Marbois"/><br /><sub><b>Tori Marbois</b></sub></a><br /></td>
+</tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

imap_processing-0.13.0/imap_processing/__init__.py

@@ -0,0 +1,34 @@
+"""Interstellar Mapping and Acceleration Probe (IMAP) data processing package.
+
+This package contains the IMAP data processing software. The package is
+organized into submodules for each instrument. Each instrument submodule
+contains code for each processing level.
+
+There are utilities to read and write IMAP data files in
+the CDF file format, and to interact with the SPICE toolkit.
+"""
+
+# When imap_processing is installed using pip, we need to be able to find the
+# packet definitions directory path.
+#
+# This directory is used by the imap_processing package to find the packet definitions.
+from pathlib import Path
+
+from imap_processing._version import __version__, __version_tuple__  # noqa: F401
+
+# Eg. imap_module_directory = /usr/local/lib/python3.11/site-packages/imap_processing
+imap_module_directory = Path(__file__).parent
+
+PROCESSING_LEVELS = {
+    "codice": ["l1a", "l1b", "l2"],
+    "glows": ["l1a", "l1b", "l2"],
+    "hi": ["l1a", "l1b", "l1c", "l2"],
+    "hit": ["l1a", "l1b", "l2"],
+    "idex": ["l1a", "l1b", "l2a", "l2b"],
+    "lo": ["l1a", "l1b", "l1c", "l2"],
+    "mag": ["l1a", "l1b", "l1c", "l1d", "l2"],
+    "spacecraft": ["l1a"],
+    "swapi": ["l1", "l2", "l3a", "l3b"],
+    "swe": ["l1a", "l1b", "l2"],
+    "ultra": ["l1a", "l1b", "l1c", "l2"],
+}

imap_processing-0.13.0/imap_processing/_version.py

@@ -0,0 +1,3 @@
+# These version placeholders will be replaced later during substitution.
+__version__ = "0.13.0"
+__version_tuple__ = (0, 13, 0)

imap_processing-0.13.0/imap_processing/ccsds/ccsds_data.py

@@ -0,0 +1,51 @@
+"""Contain a data class for CCSDS data."""
+
+from dataclasses import dataclass, fields
+
+
+@dataclass
+class CcsdsData:
+    """
+    Data class for CCSDS header.
+
+    Parameters
+    ----------
+    packet_header : dict
+        Dictionary of packet headers.
+
+    Attributes
+    ----------
+    VERSION: int
+        CCSDS Packet Version Number.
+    TYPE: int
+        CCSDS Packet Type Indicator.
+    SEC_HDR_FLG: int
+        CCSDS Packet Secondary Header Flag.
+    PKT_APID: int
+        CCSDS Packet Application Process ID.
+    SEQ_FLGS: int
+        CCSDS Packet Grouping Flags.
+    SRC_SEQ_CTR: int
+        CCSDS Packet Sequence Count.
+    PKT_LEN: int
+        CCSDS Packet Length.
+    """
+
+    VERSION: int
+    TYPE: int
+    SEC_HDR_FLG: int
+    PKT_APID: int
+    SEQ_FLGS: int
+    SRC_SEQ_CTR: int
+    PKT_LEN: int
+
+    def __init__(self, packet_header: dict):
+        attributes = [field.name for field in fields(self)]
+
+        for key, value in packet_header.items():
+            if key in attributes:
+                setattr(self, key, value)
+            else:
+                raise KeyError(
+                    f"Did not find matching attribute in Histogram data class for {key}"
+                )