Skip to main content

A framework for the HiSPARC experiment

Project description

Introduction

http://img.shields.io/pypi/v/hisparc-sapphire.png http://img.shields.io/badge/license-GPLv3-blue.png http://img.shields.io/travis/HiSPARC/sapphire/master.png http://img.shields.io/coveralls/HiSPARC/sapphire/master.png

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.

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.

David has tried very hard to write clean code. However, as is the nature of finishing a PhD, severe time constraints prevented him to actually write well-documented, clean code. He feels, however, that the presently available code is a good start. By releasing it now, it can be used, accessed, and cleaned up.

In fact, it is probably being cleaned up at this very moment!

Installation

Required: Python with pip, the HDF5 and ATLAS libraries and a Fortran compiler.

Then, using pip, simply open a Terminal and do:

$ 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: http://docs.hisparc.nl/sapphire/.

To check if it worked start Python and load the package:

import sapphire

You’re done!

Project details


Download files

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

Source Distribution

hisparc-sapphire-0.10.0.tar.gz (6.9 MB view details)

Uploaded Source

File details

Details for the file hisparc-sapphire-0.10.0.tar.gz.

File metadata

File hashes

Hashes for hisparc-sapphire-0.10.0.tar.gz
Algorithm Hash digest
SHA256 38363309fb456f74306c949c7425bfc131ecd8633cc188fe7837059b3ffaa302
MD5 db7ffb4afa313a18595b30fc5675d7dc
BLAKE2b-256 09f1d36ad6ab2e3b983bf84af09fcfc7fdf2806081fe1ea90f1b85e9a8e0ea3d

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page