Skip to content

Commit

Permalink
#9 Merge pull request from astropenguin/astropenguin/issue8
Browse files Browse the repository at this point in the history
Add description of PRIISM installation
  • Loading branch information
astropenguin committed Mar 8, 2022
2 parents bc16885 + 2e13c8a commit 3a81c50
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Python 3 environment for benchmarking PRIISM


## Usage
## Basic usage

### Install [Poetry]

Expand Down Expand Up @@ -46,6 +46,8 @@ priism-0.7.16,64,106.51

where the first, second, and third columns correspond to the PRIISM version, the number of threads used for imaging, and the elapsed time (in seconds) of imaging (i.e. `imager.solve(...)`), respectively.

## Advanced usage

### PRIISM build options

PRIISM build options can be specified by an environment variable `PRIISM_BUILD_OPTIONS`:
Expand All @@ -54,4 +56,19 @@ PRIISM build options can be specified by an environment variable `PRIISM_BUILD_O
PRIISM_BUILD_OPTIONS="-X yes" poetry run bin/hltau/benchmark priism-0.7.15,priism-0.7.16 8,32,64
```

### Use as a PRIISM installer

You may also use this repository as a simple way of installing PRIISM (and dependencies):

```bash
poetry install
PRIISM_BUILD_OPTIONS="-X yes" poetry run bin/install-priism priism-0.7.16
```

Then you can run your own script that uses PRIISM:

```bash
poetry run python /path/to/script.py
```

[Poetry]: https://python-poetry.org/

0 comments on commit 3a81c50

Please sign in to comment.