Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ewanwm authored Sep 25, 2024
1 parent 9f959b6 commit ab46c55
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,19 @@ make test
```

## Python
nuTens provides a python interface which can be installed using pip by running

nuTens provides a python interface for it's high level functionality.

### PyPi Distribution

For each nuTens release there is a corresponding python module distributed using [PyPi](https://pypi.org/project/nuTens/) which can automatically be obtained via pip using
```
pip install nuTens
```

### Manual Installation

The python interface can be installed manually after cloning the repository using pip by running
```
pip install .
```
Expand All @@ -54,6 +66,8 @@ cmake -DNT_ENABLE_PYTHON=ON <other options> <source dir>
```
and doing `make && make install`



## Benchmarking
nuTens uses [Googles benchmark library](https://github.com/google/benchmark) to perform benchmarking and tracks the results uing [Bencher](https://bencher.dev). Each benchmark consists of calculating neutrino oscillations for 1024 batches of 1024 neutrino energies using the standard PMNS formalism in vacuum and in constant density matter:

Expand Down

0 comments on commit ab46c55

Please sign in to comment.