Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/hisparc/sapphire

SAPPHiRE, a framework for HiSPARC

https://github.com/hisparc/sapphire

Science Score: 10.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 14 committers (7.1%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (19.6%) to scientific vocabulary

Keywords

analysis api cosmic-rays python science simulations

Keywords from Contributors

interactive projection sequences embedded genomics observability autograding hacking shellcodes archival
Last synced: 5 months ago · JSON representation

Repository

SAPPHiRE, a framework for HiSPARC

Basic Info
Statistics
  • Stars: 7
  • Watchers: 18
  • Forks: 9
  • Open Issues: 20
  • Releases: 0
Topics
analysis api cosmic-rays python science simulations
Created over 13 years ago · Last pushed 6 months ago
Metadata Files
Readme License

README.rst 

SAPPHiRE — A Framework for HiSPARC
===================================

Introduction
------------

.. image:: https://img.shields.io/pypi/v/hisparc-sapphire
   :target: https://pypi.python.org/pypi/hisparc-sapphire/
.. image:: https://img.shields.io/badge/license-GPLv3-blue
   :target: https://github.com/HiSPARC/sapphire/blob/master/LICENSE
.. image:: https://img.shields.io/github/actions/workflow/status/HiSPARC/sapphire/tests.yml?branch=master
   :target: https://github.com/HiSPARC/sapphire/actions

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:

.. code-block:: python

    import sapphire

You'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.

Owner

  • Name: HiSPARC
  • Login: HiSPARC
  • Kind: organization
  • Location: Nikhef

High-School Project on Astrophysics Research with Cosmics

GitHub Events

Total
  • Delete event: 51
  • Issue comment event: 44
  • Push event: 23
  • Pull request review event: 3
  • Pull request event: 110
  • Create event: 45
Last Year
  • Delete event: 51
  • Issue comment event: 44
  • Push event: 23
  • Pull request review event: 3
  • Pull request event: 110
  • Create event: 45

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 2,727
  • Total Committers: 14
  • Avg Commits per committer: 194.786
  • Development Distribution Score (DDS): 0.537
Past Year
  • Commits: 10
  • Committers: 2
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.5
Top Committers
Name Email Commits
Arne de Laat a****t@n****l 1,262
David Fokkema d****f@n****l 652
Tom Kooij t****j@t****l 320
David Fokkema d****a@g****m 242
Arne de Laat a****e@d****t 177
Hans Montanus h****m@n****l 27
Edekje e****m@y****m 24
Niek Schultheiss n****s@n****l 9
dependabot[bot] 4****] 5
Achintya Rao a****o@c****h 3
Tom Kooij t****j@n****l 3
Tom Kooij T****j 1
Valentin Niess n****s@i****r 1
Javier Gonzalez j****z@i****e 1
Committer Domains (Top 20 + Academic)
nikhef.nl: 5 ik.fzk.de: 1 in2p3.fr: 1 cern.ch: 1 delaat.net: 1 tomkooij.nl: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 41
  • Total pull requests: 199
  • Average time to close issues: 4 months
  • Average time to close pull requests: 4 months
  • Total issue authors: 4
  • Total pull request authors: 6
  • Average comments per issue: 3.95
  • Average comments per pull request: 1.44
  • Merged pull requests: 97
  • Bot issues: 0
  • Bot pull requests: 134
Past Year
  • Issues: 1
  • Pull requests: 106
  • Average time to close issues: N/A
  • Average time to close pull requests: 10 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.68
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 103
View more stats
Top Authors
Issue Authors
  • 153957 (26)
  • tomkooij (13)
  • kaspervd (1)
  • deKeijzer (1)
Pull Request Authors
  • dependabot[bot] (151)
  • 153957 (32)
  • tomkooij (31)
  • niess (1)
  • Edekje (1)
  • RaoOfPhysics (1)
Top Labels
Issue Labels
enhancement (6) bug (4) question (2)
Pull Request Labels
dependencies (151) python (140) enhancement (9) don't merge yet (5) github_actions (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 261 last-month
  • Total docker downloads: 44
  • Total dependent packages: 0
  • Total dependent repositories: 4
  • Total versions: 66
  • Total maintainers: 4
pypi.org: hisparc-sapphire

A framework for the HiSPARC experiment

  • Versions: 66
  • Dependent Packages: 0
  • Dependent Repositories: 4
  • Downloads: 261 Last month
  • Docker Downloads: 44
Rankings
Docker downloads count: 2.8%
Dependent packages count: 7.3%
Dependent repos count: 7.7%
Forks count: 11.0%
Average: 11.9%
Stargazers count: 19.4%
Downloads: 23.1%
Maintainers (4)
153957 davidfokkema tomkooij HiSPARC
Last synced: 6 months ago

Dependencies

setup.py pypi
  • numpy *
  • progressbar2 >=3.7.0
  • scipy *
  • tables >=3.3.0
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • conda-incubator/setup-miniconda v2 composite
  • peaceiris/actions-gh-pages v3.9.1 composite