SAPPHiRE — A Framework for HiSPARC
Introduction
SAPPHiRE is a Simulation and Analysis Program Package for HiSPARC Research and Education. It was created in the process of completing the PhD research of David Fokkema. The history of this repository contains the complete simulation, analysis and plot generation code that formed the basis for David’s thesis. Arne de Laat took over development of SAPPHiRE while working on his own PhD research.
This repository is created with a sole purpose in mind: to enable HiSPARC students, teachers and researchers to easily gain access to the data and perform common simulation and analysis tasks. Historically, starting work on the data, or extending an existing analysis code, has involved elaborate installation instructions, heavy customizations to the software, countless hours going over opaque parts of code and a general feeling of anguish and despair. SAPPHiRE’s ultimate goal: no more of that.
Installation
Required: Python. pip will take care of dependencies, but installing numpy, scipy and pytables from a python distribution is preferred. We use miniconda, which includes the conda package manager.
First, install conda and optionally create a virtualenv:
$ conda create --name hisparc python numpy scipy pytables $ source activate hisparc
or alternatively just install the dependencies:
$ conda install numpy scipy pytables sphinx
Then, using pip:
$ pip install hisparc-sapphire
This should install sapphire with all requirements. More extensive installation instructions are available in the documentation in the doc/ directory. You can compile them using Sphinx, or you can follow this link: https://docs.hisparc.nl/sapphire/.
To check if it worked start Python and load the package:
import sapphireYou’re done!
Development
Install python (preferably using conda) as described above but clone the sapphire repo instead of installing using pip:
$ git clone https://github.com/HiSPARC/sapphire.git $ cd sapphire $ pip install -e .[dev]
Version release
Important: First check if the last commit passes the tests on GitHub Actions!
To release a new version modify the version number in setup.py. Then create a commit for the new release with a title like ‘Bump version to vX.Y.Z’ and a message that contains a summary of the most important changes since the last release. Then tag the commit and push it to GitHub:
$ git tag vX.Y.Z $ git push --tags
Then upload the new version to PyPI (this requires the build, wheel and twine packages):
$ python -m build $ twine upload dist/hisparc-sapphire-X.Y.Z.tar.gz $ twine upload dist/hisparc_sapphire-X.Y.Z-py3-none-any.whl
The latest version is then available from PyPI.
4 maintainers
Metadata
4 maintainers
Release files for hisparc-sapphire 3.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| hisparc_sapphire-3.1.0.tar.gz | 7.5 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hisparc_sapphire-3.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 14.7 MB
Release files / hisparc_sapphire-3.1.0.tar.gz
| Download URL | hisparc_sapphire-3.1.0.tar.gz |
|---|---|
| Size | 7.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1eb5fbcae89d23e20bc9a134f7cc74530ffc243119e495c7179f218b10eb3401
|
|
BLAKE2b-256 checksum How to use checksums |
3c4f463b7aee4adf78982ddfe0f67f3992c2e79df1def192c72892b9f6155244
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.28.1
|
Release files / hisparc_sapphire-3.1.0-py3-none-any.whl
| Download URL | hisparc_sapphire-3.1.0-py3-none-any.whl |
|---|---|
| Size | 7.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9360992ccbd03d75eab036c519402ebe69d848c9ffa3fe9160491cc2d1d09121
|
|
BLAKE2b-256 checksum How to use checksums |
a9f97a16aa613e212b16a2c7b28c9b0df54a1625eff97e9d9e861a3f4f895571
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.28.1
|
Security for hisparc-sapphire 3.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
