punchbowl
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
- Clone this repository on your local machine
- Navigate to the repository and create a virtual environment in Python using
uvwithuv sync --no-sources --no-dev(super users who want to install optional-dependencies, useuv sync --no-sources --no-dev --all-extras) - Activate the virtual environment by running
source .venv/bin/activateon Mac/Linux or.venv\Scripts\activateon Windows - Explore some data!
Using venv
- Clone this repository on your local machine
- Navigate to the repository and create a virtual environment in Python using
python -m venv my_venv_name - Activate the virtual environment by running
source my_venv_name/bin/activateon Mac/Linux ormy_venv_name\Scripts\activateon Windows - Install the project environment dependencies by running
pip install .(super users who want to install optional-dependencies, usepip install -e ".[super-user]") - 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.
- Install Podman Desktop using your preferred method
- Pull the mariadb image with podman pull docker.io/library/mariadb
- 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
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
648a25182b5c9927fb73cd17f1768583d66572271821dcb195ae18396dce7385
|
|
| MD5 |
98e755d99d2022e2e9a87a26bcc88955
|
|
| BLAKE2b-256 |
83adcc96d1685a9ab8b1b30ae6cdf62c45b5a8d47f7fd45b5ddd95b338b5b983
|
Provenance
The following attestation bundles were made for punchbowl-0.0.24.tar.gz:
Publisher:
python-publish.yaml on punch-mission/punchbowl
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
punchbowl-0.0.24.tar.gz -
Subject digest:
648a25182b5c9927fb73cd17f1768583d66572271821dcb195ae18396dce7385 - Sigstore transparency entry: 2269082564
- Sigstore integration time:
-
Permalink:
punch-mission/punchbowl@e83d02b3ddb56418bb35900d8309420e4ea36b73 -
Branch / Tag:
refs/tags/0.0.24 - Owner: https://github.com/punch-mission
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yaml@e83d02b3ddb56418bb35900d8309420e4ea36b73 -
Trigger Event:
release
-
Statement type: