Skip to content

Commit

Permalink
Merge pull request #22 from ewanwm/ewanwm-patch-1
Browse files Browse the repository at this point in the history
Tidy README.md a bit
  • Loading branch information
ewanwm authored Jul 16, 2024
2 parents 49181f7 + 5a1b373 commit c09ed9b
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
<a name="nutens"></a>
# <img src="doc/nuTens-logo.png" alt="nuTens" class="right" align="top" width="400"/>


# nuTens

A lightweight library for calculating neutrino oscillation probabilities using tensors typically used in machine learning.

<img src="doc/nuTens-logo.png" alt="nuTens" class="right" align="top" width="400"/>
nuTens is a software library which uses [tensors](https://en.wikipedia.org/wiki/Tensor_(machine_learning)) to efficiently calculate neutrino oscillation probabilities.

[![CI badge](https://github.com/ewanwm/nuTens/actions/workflows/CI-build-and-test.yml/badge.svg)](https://github.com/ewanwm/nuTens/actions/workflows/CI-build-and-test.yml)
[![Code - Doxygen](https://img.shields.io/badge/Code-Doxygen-2ea44f)](https://ewanwm.github.io/nuTens/index.html)
Expand All @@ -22,7 +19,7 @@ A lightweight library for calculating neutrino oscillation probabilities using t
(or see [PyTorch installation instructions](https://pytorch.org/get-started/locally/) for instructions on how to build yourself)

### Installation
Assuming PyTorch was built using pip, nuTens can be built using
Assuming PyTorch was built using pip, [nuTens](#nutens) can be built using
```
mkdir build
cd build
Expand All @@ -33,7 +30,7 @@ make <-j Njobs>
(installation with a non-pip install of PyTorch have not been tested but should be possible)

### Verifying Installation
Once nuTens has been built, you can verify your installation by running
Once [nuTens](#nutens) has been built, you can verify your installation by running
```
make test
```
Expand Down

0 comments on commit c09ed9b

Please sign in to comment.