PipMag is a Python package developed to provide a streamlined and intuitive interface for browsing and querying solar observation data collected by the Swedish Solar Telescope (SST).
This project aims to assist users by offering a powerful tool to navigate through a vast amount of solar data by simplifying the process of data retrieval and organization.
In this wiki, you will find comprehensive documentation that guides you through the installation and usage of PipMag, explains the data structure it uses, outlines the conventions for naming quick-look movies, and much more. Each page in the wiki is designed to help you understand different aspects of the project, whether you're a user seeking to extract valuable insights from SST data or a contributor looking to add new features to the package.
Here's an overview of what you can find in this wiki:
- Installation: Detailed instructions on setting up PipMag in your local environment.
- Creating the SST Observations Database: A guide to creating and interacting with the SST observations database.
- Setting up Configuration File: Steps for setting up the
config.inifile and obtaining theADS_DEV_KEY. - Working with Git Large File Storage (LFS): A guide on how to use Git LFS when contributing large CSV files.
- Commit Message Guidelines: Best practices for writing meaningful commit messages.
- Repository Structure: An overview of the structure and content of the PipMag repository.
- Quicklook Movie Filename Convention: The convention used for naming quicklook movies.
- La Palma Data Frame Structure: An explanation of the data frame structure used to store observations data.
- Contributing to the repository: Guidelines on contributing to this repository.
If you have any questions or suggestions, please raise an issue on the project's GitHub page.