diff --git a/README.md b/README.rst similarity index 63% rename from README.md rename to README.rst index 10fbae1..e3696d5 100644 --- a/README.md +++ b/README.rst @@ -1,24 +1,27 @@ -## EOS - The AMOR focusing reflectometry data reduction software +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**: +Reduction of the raw files (.hdf) to reflectivity files in one of the representations of the **ORSO reflectivity file format**: -> `eos.py --help` + eos.py --help visualisation of the content of a raw file (.hdf): -> `events2histogram.py` + events2histogram.py -#TODO: real readme for final system needed. +:TODO: real readme for final system needed. -## Installation +Installation +------------ Create a virtual python environment (>3.8) and install the PyPI package: -> pip install amor-eos + 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