Metadata-Version: 2.4
Name: sipmarray
Version: 1.2
Summary: A simple package to get the geometry of SiPM arrays.
Author-email: Ricardo Peres <r.motaperes@imperial.ac.uk>
Project-URL: Homepage, https://github.com/ricmperes/sipmarray
Project-URL: Bug Tracker, https://github.com/ricmperes/sipmarray/issues
Project-URL: Documentation, https://ricmperes.github.io/sipmarray/
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: pandas
Dynamic: license-file

# sipmarray

[![PyPI version shields.io](https://img.shields.io/pypi/v/sipmarray.svg)](https://pypi.org/project/sipmarray/) [![Static Badge](https://img.shields.io/badge/Docs-%235F9EA0)](https://ricmperes.github.io/sipmarray/)

> Ricardo Peres, 2023

This pakacge provides a quick and easy way to get the goemetry of circular SiPM arrays. It was developed to know how many SiPM would be required to fully instrument a [DARWIN](https://darwin.physik.uzh.ch/)- or [XLZD](https://xlzd.org/)-size detector.

More SiPM unit options coming soon!

## Instalation
```bash
pip install sipmarray
```

To install with an editable source:

```bash
git clone git@github.com:ricmperes/sipmarray.git
cd sipmarray 
pip install -e .
```

## Usage

In a jupyter notebook simply `import sipmarray`. Take a look at the [docs](https://ricmperes.github.io/sipmarray/) and example notebook (really, the package is pretty simple and self-explanatory).

The package can be used from the terminal (from anywhere woop woop!) to quickly get a plot or coordinate geometry of a sipmarray or sipmunit. Check the `sipmarray/Do the following for more info: 
  * `sipmarray --help`
  * `sipmunit --help`
