README.md

# Detector geometry tools

This package is a collection of tools implementing different small operations related to detector geometry, like reading Crystfel stream file, read motors data, plot some metrics, etc.

To refine geometry, try:
```shell
geomtools-refine-sfx -h
```

To make report on geometry quality and push geometry to SPB repository, try:
```shell
module load texlive
geomtools-push -h
```


## Installation

If you are installing on Maxwell it may be convenient to start by loading `exfel_anaconda3` module:

```
module load exfel exfel_anaconda3
```

or you can use your own installation of python version 3.7 or later. Next:

```
git clone ssh://git@git.xfel.eu:10022/esobolev/geomtools.git
cd geomtools
python -m venv myenv
source myenv/bin/activate
pip install -U pip
pip install .
```