From 5fd6548abca6e0fb4b5a366bcd6de6e7de087576 Mon Sep 17 00:00:00 2001 From: Killian Sheriff Date: Fri, 2 Feb 2024 07:21:42 -0800 Subject: [PATCH] update --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 31e026e..dd67a38 100644 --- a/README.md +++ b/README.md @@ -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} +} +``` \ No newline at end of file