Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
YannickDieter committed Jan 9, 2018
1 parent 33d81de commit 74f22c5
Showing 1 changed file with 13 additions and 17 deletions.
30 changes: 13 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,45 @@
# pymosa
A Mimosa26 telescope readout in Python with MMC3 hardware
A Mimosa26 telescope readout in Python with MMC3 (Multi Module Card) hardware

## Description

Pymosa features continuous and triggerless data taking of up to 6 Mimosa26 sensors, enabling operation at particle rates of up to 20 kHz.
The configuration of the Mimosa26 sensors can also be done with pymosa (via JTAG).

Readout and configuration are based on a single FPGA-readout board, the MMC3 readout board (see picture).
Readout and configuration are based on a single FPGA-readout board, the MMC3 readout board.

Via six Ethernet cables the data of the six Mimosa26 sensors is streamed to the readout board. An additional Ethernet cable is used to configure the Mimosa26 sensors
via a distributer board.
The trigger words (from TLU) are recieved with an additional Ethernet cable.
These are needed in order to correlate Mimosa26 frame data with a time reference plane in order to obtain a time information for Mimosa26 data.
The data is streamed to the host PC via another Ethernet cable.
The data of the Mimosa26 sensors is streamed continuously to the readout board using RJ45 connectors. An additional RJ45 connection is used for the
configuration (JTAG) of the Mimosa26 sensors. An extra RJ45 connection provides the interface with the TLU.
Trigger words from TLU are needed in order to correlate Mimosa26 frame data with a time reference plane in order to obtain a time information for Mimosa26 data.
The data between the host PC and the readout board is transmitted via Transmission Control Protocol / Internet Protocol (TCP/IP).
For powering the MMC3 readout board a 5 V DC power supply is needed.

Pymmosa contains the following configuration files:
- configuration.yaml:
Within pymosa the configuration can be set with the following files:

- **configuration.yaml**:
Main configuration file in which run is set up and triggers are configured.
- /m26_config/mmc3_anemone_th11.yaml (or other thresholds):
- **/m26_config/mmc3_anemone_th11.yaml** (or other thresholds):
Contains Mimosa26 sensor configuration. By changing the number of the configuration file, the sensor threshold can be changed (between 4 - 11).
- m26.yaml:
- **m26.yaml**:
Basil configuration file containing all the necessary information about the DUT (hardware setup).

## Installation
Install [conda](http://conda.pydata.org).

Install additional required packages:
```bash
conda install numpy pyyaml pytables
conda install bitarray numpy pytables pyyaml
```

Finally, install pymosa via:
```bash
pip install pymosa
```

TBD

## Usage
Before running telescope readout setup run and trigger configuration in configuration file (e.g. configuration.yaml).

Run telescope readout via:
```bash
pymosa
python m26.py
```


0 comments on commit 74f22c5

Please sign in to comment.