Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
killiansheriff committed Feb 2, 2024
1 parent c78919a commit 5fd6548
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,25 @@ polya = Polya(graph_name="fcc", ntypes=3)
p_g, nms = polya.get_gt()
print(p_g)
```

## Installation
For a standalone Python package or Conda environment, please use:
```bash
pip install --user Polya
```

If you want to install the lastest git commit, please replace ``Polya`` by ``git+https://github.com/killiansheriff/Polya.git``.

## Contact
If any questions, feel free to contact me (ksheriff at mit dot edu).

## References & Citing
If you use this repository in your work, please cite:

```
@article{TOBEUPDATED,
title={TOBEUPDATED},
author={Sheriff, Killian and Cao, Yifan and Freitas, Rodrigo},
journal={arXiv preprint TOBEUPDATED},
year={2024}
}
```

0 comments on commit 5fd6548

Please sign in to comment.