sinq-reflectometry/eos
0
1
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases 1 Wiki Activity

change to rst README

Browse Source
This commit is contained in:
glavic_a
2024-10-30 15:36:43 +01:00
parent 80d1014750
commit d4462f450e
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md → README.rst
View File

@@ -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