updated Documentation and README (#274)
Some checks failed
Build on RHEL8 / build (push) Successful in 2m38s
Build on RHEL9 / build (push) Successful in 2m58s
Run tests using data on local RHEL8 / build (push) Failing after 3m16s

This commit is contained in:
2026-02-19 11:22:35 +01:00
committed by GitHub
parent 218f31ce60
commit 1f7a87cc30
2 changed files with 32 additions and 8 deletions

View File

@@ -25,27 +25,30 @@ mkdir build
cd build
#configure using cmake
cmake ../aare
cmake ../aare -DAARE_PYTHON_BINDINGS=ON
#build (replace 4 with the number of threads you want to use)
make -j4
```
Now you can use the Python module from your build directory
Now you can use the Python module from your build directory
```python
import aare
f = aare.File('Some/File/I/Want_to_open_master_0.json')
```
To run form other folders either add the path to your conda environment using conda-build or add it to your PYTHONPATH
To run from other folders either add the path to your conda environment using conda-build or add the module to your PYTHONPATH
```bash
export PYTHONPATH=path_to_aare/aare/build:$PYTHONPATH
```
### Install using conda/mamba
```bash
#enable your env first!
conda install aare=2024.10.29.dev0 -c slsdetectorgroup
conda install aare -c slsdetectorgroup # installs latest version
```
### Install to a custom location and use in your project