detectors/python_cluster_reader
Archived
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated README

Browse Source
This commit is contained in:
Erik Frojdh 2023-05-31 14:29:03 +02:00
parent b21ae3da2e
commit 9b2f8a2eb9
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -10,7 +10,15 @@ Useful links:
**Simplified build using make** **Simplified build using make**
```bash ```bash
make #build c extension inplace $ make #build c extension inplace
```
```
$ make help
clean Remove the build folder and the shared library
debug Build extension with debug prints and assertions
ext [DEFAULT] build c extension in place
test Run unit tests using pytest
``` ```
**Manual build** **Manual build**
@ -19,19 +27,19 @@ make #build c extension inplace
#build in place and use from the same folder #build in place and use from the same folder
#sometimes necessary to remove build folder and .so #sometimes necessary to remove build folder and .so
#by hand #by hand
python setup.py build_ext --inplace $ python setup.py build_ext --inplace
``` ```
To use make sure that the .so and potentially python files are in PYTHONPATH (or installed in developer mode) To use make sure that the .so and potentially python files are in PYTHONPATH (or installed in developer mode)
```bash ```bash
#conda #conda
conda develop install . $ conda develop install .
#or with pip #or with pip
pip install --editable . $ pip install --editable .
``` ```
## Cluster file specifications ## Cluster file specifications