Skip to main content

punchbowl

DOI

punchbowl is the science calibration code for the PUNCH mission.

Start by checking the documentation.

[!CAUTION] This package is still being heavily edited as calibration algorithms are improved. Stability is not promised until v1.

Accessing the data

Data are available via the Solar Data Analysis Center. See the PUNCH website for details.

Installing punchbowl

Install with pip install punchbowl to get the released version.

To get the latest unreleased version: clone the repo and install it locally.

Setting up the PUNCH environment

Using uv

  1. Clone this repository on your local machine
  2. Navigate to the repository and create a virtual environment in Python using uv with uv sync --no-sources --no-dev (super users who want to install optional-dependencies, use uv sync --no-sources --no-dev --all-extras)
  3. Activate the virtual environment by running source .venv/bin/activate on Mac/Linux or .venv\Scripts\activate on Windows
  4. Explore some data!

Using venv

  1. Clone this repository on your local machine
  2. Navigate to the repository and create a virtual environment in Python using python -m venv my_venv_name
  3. Activate the virtual environment by running source my_venv_name/bin/activate on Mac/Linux or my_venv_name\Scripts\activate on Windows
  4. Install the project environment dependencies by running pip install . (super users who want to install optional-dependencies, use pip install -e ".[super-user]")
  5. Explore some data!

Running punchbowl

The documentation provides details on how to run the various components. It also provides a short explanation of each underlying algorithm. Please reach out with a discussion for more help.

Testing

You need Docker or Podman Desktop.

  1. Install Podman Desktop using your preferred method
  2. Pull the mariadb image with podman pull docker.io/library/mariadb
  3. Run tests with pytest

Getting help

Please open an issue or discussion on this repo.

Contributing

We appreciate all contributions. If you have a problem with the code or would like to see a new feature, please open an issue. Or you can submit a pull request.

Thanks to all the contributors to punchbowl!

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

punchbowl-0.0.24.tar.gz (14.9 MB view details)

Uploaded Source

File details

Details for the file punchbowl-0.0.24.tar.gz.

File metadata

  • Download URL: punchbowl-0.0.24.tar.gz
  • Upload date:
  • Size: 14.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for punchbowl-0.0.24.tar.gz
Algorithm Hash digest
SHA256 648a25182b5c9927fb73cd17f1768583d66572271821dcb195ae18396dce7385
MD5 98e755d99d2022e2e9a87a26bcc88955
BLAKE2b-256 83adcc96d1685a9ab8b1b30ae6cdf62c45b5a8d47f7fd45b5ddd95b338b5b983

See more details on using hashes here.

Provenance

The following attestation bundles were made for punchbowl-0.0.24.tar.gz:

Publisher: python-publish.yaml on punch-mission/punchbowl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.0.24 This release

1 file

0.0.23

1 file

0.0.22

1 file

0.0.21

1 file

0.0.20

1 file

0.0.19

1 file

0.0.18

1 file

0.0.17

1 file

0.0.16

1 file

0.0.15

1 file

0.0.14

1 file

0.0.13

1 file

0.0.12

1 file

0.0.11

1 file

0.0.10

1 file

0.0.9

1 file

0.0.8

1 file

0.0.7

1 file

0.0.6

1 file

0.0.5

1 file

0.0.4

1 file

0.0.3

1 file

0.0.2

1 file

0.0.0

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page