Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adds more data, revises guide, expands README #4

Merged
merged 13 commits into from
Jun 17, 2024
1 change: 1 addition & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Please see our mission-wide code of conduct here.](https://github.com/punch-mission/punch-mission/blob/main/CODE_OF_CONDUCT.md)
606 changes: 0 additions & 606 deletions PUNCHData guide.ipynb

This file was deleted.

46 changes: 33 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,36 @@
# PUNCH 5 Science Meeting SOC Materials

> [!warning]
> **This collection of material is not yet finalized.**

[![DOI](https://zenodo.org/badge/797922406.svg)](https://zenodo.org/doi/10.5281/zenodo.11507132)

Examples from the SOC for the [fifth PUNCH Science Meeting](https://punch.space.swri.edu/punch5meeting.php)

## Data
## What's here?

This repository includes the following materials:

- *lowder_slides.pdf*: slides from Chris Lowder that were presented at the meeting about how to use the data
- *hughes_premeeting_slides.pdf*: slides from Marcus Hughes introducing the SOC at the premeeting
- *guide.ipynb*: a notebook that explains how to utilize PUNCH data
- *requirements.txt*: the Python packages used by the notebook
- *example_data/*: a few files to explore the data with
- *LICENSE*: a license for using these materials

## Getting started

0. Make sure you have Python 3.10 or later installed.
1. Clone this repo.
2. Install the packages with `pip install -r requirements.txt`. We encourage doing this in a clean virtual environment. [This guide](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/) will help you do this.
3. Open the `guide.ipynb` in your preferred Jupyter environment and follow along.

To access the full set of images go to [https://data.boulder.swri.edu/mhughes/punch_synthetic_data/](https://data.boulder.swri.edu/mhughes/punch_synthetic_data/).
### What if I use IDL?

As data is improved a new version will be released. The first version is in the v1 folder. The second in v2 and so forth.
A sample IDL script for reading PUNCH data is under development at https://github.com/punch-mission/PUNCH_IDL_Tools. You may find the `guide.ipynb` helpful to learn about how the data is structured, but we do not have a corresponding IDL tutorial.

This data simulates real PUNCH Level 3 data.
It does not include a starfield or F-corona.
The next iteration of this data will include realistic noise.
## What are the `example_data`?

These data simulates real PUNCH Level 3 data.
They does not include a starfield or F-corona.
The next iteration of these data will include realistic noise.

- L3 - Level 3 total brightness and polarized brightness
- PAM - PUNCH Level-3 Polarized Low Noise Mosaic – 32 minutes
Expand All @@ -25,16 +40,21 @@ The next iteration of this data will include realistic noise.

Data are RICE compressed. The calibrated brightness values are stored in the second HDU. An associated placeholder uncertainty array is stored in the third HDU.

Data can be read in with the default astropy.io.fits libraries.
Data can be read in with the default astropy.io.fits libraries.

With the public release of PUNCH Python tools, a more sophisticated data handler capable of reading PUNCH data and bundling the data and WCS information will be available at https://github.com/punch-mission.

With the public release of PUNCH Python tools, a more sophisticated data handler capable of reading PUNCH data and bundling the data and WCS information will be available at https://github.com/punch-mission.
A sample IDL script for reading PUNCH data is under development at https://github.com/punch-mission/PUNCH_IDL_Tools.
### How do I get more data?

### Description of versions
To access the full set of images go to [https://data.boulder.swri.edu/mhughes/punch_synthetic_data/](https://data.boulder.swri.edu/mhughes/punch_synthetic_data/).

As data are improved a new version will be released. The first version is in the v1 folder. The second in v2 and so forth.

- v1: the initial version
- v2: fixes WCS misalignment, makes uncertainty more realistic, fixes scaling problem in data

This demo uses `v2` files.

## Getting help

Please open an issue or create a discussion for help with these data and files.
30,349 changes: 30,349 additions & 0 deletions example_data/PUNCH_L3_PAN_20240620000000.fits

Large diffs are not rendered by default.

30,349 changes: 30,349 additions & 0 deletions example_data/PUNCH_L3_PNN_20240620000000.fits

Large diffs are not rendered by default.

194,678 changes: 194,678 additions & 0 deletions example_data/PUNCH_L3_PTM_20240620000000.fits

Large diffs are not rendered by default.

Loading