Skip to content

Commit 9c5cae7

Browse files
authored
Update README.md
1 parent fb96a3a commit 9c5cae7

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,10 @@ using only matrix-vector products. ``traceax`` is heavily inspired by
1414
[lineax](https://github.com/patrick-kidger/lineax) as well as
1515
[XTrace](https://github.com/eepperly/XTrace).
1616

17-
18-
1917
[**Installation**](#installation)
2018
| [**Example**](#get-started-with-example)
2119
| [**Documentation**](#documentation)
20+
| [**Citation**](#citation)
2221
| [**Notes**](#notes)
2322
| [**Support**](#support)
2423
| [**Other Software**](#other-software)
@@ -27,12 +26,20 @@ using only matrix-vector products. ``traceax`` is heavily inspired by
2726

2827
## Installation
2928

30-
Users can download the latest repository and then use `pip`:
29+
Users can directly install from `pip`:
3130

3231
``` bash
3332
pip install traceax
3433
```
3534

35+
Or, users can download the latest repository and then use `pip`:
36+
37+
```
38+
git clone https://github.com/mancusolab/traceax.git
39+
cd traceax
40+
pip install .
41+
```
42+
3643
## Get Started with Example
3744

3845
```python
@@ -87,6 +94,10 @@ print(nt.estimate(key4, operator, k)) # (Array(3.3297246, dtype=float32), {'std
8794
## Documentation
8895
Documentation is available at [here](https://mancusolab.github.io/traceax/).
8996

97+
## Citation
98+
If you use `traceax` in your work, please cite:
99+
100+
> Nahid, A.A., Serafin, L., Mancuso, N. (2025). <i>traceax</i>: a JAX-based framework for stochastic trace estimation. bioRxiv (https://doi.org/10.1101/2025.07.14.662216)
90101
91102
## Notes
92103

0 commit comments

Comments
 (0)