IMAP Processing Documentation
=============================

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 Website <https://imap.princeton.edu/>`_ contains information about the
entire mission, including the science goals, the spacecraft, and the instruments.
The Science Operations Center (SOC) is responsible for the data processing on the
IMAP mission and being developed at
`LASP (Laboratory of Atmospheric and Space Physics) <https://lasp.colorado.edu/>`_.

To get started with the project: :ref:`getting-started`.

The explicit code interfaces and structure are described in the :ref:`algorithm-code-documentation`.

.. toctree::
   :maxdepth: 1

   Onboarding & Collaboration <development/index>
   IMAP Data Access Tool <data-access/index>
   CDF Metadata Resources <cdf-metadata/index>
   Filename Conventions <filename-convention/index>
   SDC Project Management <project-management/index>
   Algorithm Code Documentation <algorithm-code-documentation/index>


If you make use of any ``imap_processing`` code, please consider citing it in your research.
`https://zenodo.org/record/11168295 <https://zenodo.org/record/11168295>`_

Contributing to IMAP
--------------------

We welcome contributions to the IMAP project.

The IMAP project's `Git repository <https://github.com/IMAP-Science-Operations-Center/imap_processing>`_ 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.

Before contributing, please read through our :ref:`style-guide-overview`.

For more information on contributing to open science initiatives and to learn about tools and technologies, you can look to the NASA TOPS `Open Science 101 <https://nasa.github.io/Transform-to-Open-Science/take-os101/>`_ for free classes on Open Science and open source projects.