From 80d101475002cf42ffd2ed61caee22560cf5807a Mon Sep 17 00:00:00 2001 From: Artur Glavic Date: Wed, 30 Oct 2024 15:05:33 +0100 Subject: [PATCH] update readme with installation instructions --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8fdbf05..10fbae1 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,24 @@ +## EOS - The AMOR focusing reflectometry data reduction software + +.. image:: https://img.shields.io/pypi/v/amor-eos.svg + :target: https://pypi.python.org/pypi/amor-eos/ + Software repository for the neutron reflectometer Amor at the Paul Scherrer Institut, Switzerland reduction of the raw files (.hdf) to reflectivity files in one of the representations of the **ORSO reflectivity file format**: -> `eos.py` -> `neos.py` : version for playing and testing +> `eos.py --help` visualisation of the content of a raw file (.hdf): > `events2histogram.py` #TODO: real readme for final system needed. + +## Installation +Create a virtual python environment (>3.8) and install the PyPI package: + +> pip install amor-eos + +On Windows you can also use the binary eos.exe that you find in the +[GitHub Releases]([https://github.com/jochenstahn/amor/releases/latest) section