semvec/pypi-packages huggingface dataset:
quadcelldetector 0.0.1.dev123
A library to simulate the electronic output resulting from the passage of a gaussian beam over a quadrant cell photodiode

# QuadCellDetector

[![Documentation Status](https://readthedocs.org/projects/quadcelldetector/badge/?version=latest)](https://quadcelldetector.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://travis-ci.org/university-of-southern-maine-physics/QuadCellDetector.svg?branch=master)](https://travis-ci.org/university-of-southern-maine-physics/QuadCellDetector)

A Python package designed to simulate the electronic response of a circular quadrant cell photodiode to the passage of a gaussian profile laser beam across its surface.

## Overview

The package simulates circular quadrant cell detectors, where the quadrant cell is characterized by a radius, and a gap that separates the four active photocell quadrants. This code allows the user to specify the beam shape, the path the beam takes across the detector, and it will output the signals produced by the photodiode: the sum of all four quadrants, the top two minus the bottom two, and the left two minus the right two.

## Installation

You can install this package with pip through our PyPi package with the command
```
pip install quadcelldetector
```

Alternatively, since we use `pbr` in `setup.py`, you can install from this github repository with

```
https://github.com/university-of-southern-maine-physics/QuadCellDetector.git
cd QuadCellDetector
pip install .
```

## Examples

To see a complete demonstration of the library features, see the [DetectorDemo][0] Jupyter notebook.

[0]: https://github.com/university-of-southern-maine-physics/QuadCellDetector/blob/master/demos/DetectorDemo.ipynb

### How To Get Help (or Help Us)

If you found a bug, have a question, or otherwise need to contact us, please [read this][0].

If you want to help us in the development process, or have an idea, [read this.][1]

## Contributors

+ [Paul Nakroshis](https://github.com/paulnakroshis)
+ [Ben Montgomery](https://github.com/Nyctanthous)

[0]: https://github.com/university-of-southern-maine-physics/QuadCellDetector/blob/master/CONTRIBUTING.md#if-you-found-a-bug
[1]: https://github.com/university-of-southern-maine-physics/QuadCellDetector/blob/master/CONTRIBUTING.md#if-you-want-to-contribute-code