Merge pull request #11 from pythonhealthdatascience/dev_amy

Dev amy

Author: TomMonks

CITATION.cff

@@ -0,0 +1,36 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: >-
+  Using Large Language Models to support researchers
+  reproduce and reuse unpublished health care discrete-event
+  simulation computer models: a feasibility and pilot study
+  in Python
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Thomas
+    family-names: Monks
+    orcid: 'https://orcid.org/0000-0003-2631-4481'
+    affiliation: University of Exeter
+    email: t.m.w.monks@exeter.ac.uk
+  - given-names: Alison
+    family-names: Harper
+    affiliation: University of Exeter
+    orcid: 'https://orcid.org/0000-0001-5274-5037'
+    email: a.l.harper@exeter.ac.uk
+  - given-names: Amy
+    family-names: Heather
+    email: a.heather2@exeter.ac.uk
+    affiliation: University of Exeter
+    orcid: 'https://orcid.org/0000-0002-6596-3479'
+  - given-names: Navonil
+    family-names: Mustafee
+    orcid: 'https://orcid.org/0000-0002-2204-8924'
+    affiliation: University of Exeter
+    email: n.mustafee@exeter.ac.uk
+repository-code: 'https://github.com/pythonhealthdatascience/llm_simpy'
+license: MIT

README.md

@@ -1,27 +1,27 @@
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/release/python-360+/)
-[![PyPI version fury.io](https://badge.fury.io/py/treat-sim.svg)](https://pypi.org/project/treat-sim/)
-[![ORCID: Harper](https://img.shields.io/badge/ORCID-0000--0001--5274--5037-brightgreen)](https://orcid.org/0000-0001-5274-5037)
-[![ORCID: Monks](https://img.shields.io/badge/ORCID-0000--0003--2631--4481-brightgreen)](https://orcid.org/0000-0003-2631-4481)
+[![Licence: MIT](https://img.shields.io/badge/Licence-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.10+](https://img.shields.io/badge/-Python_≥_3.10-306998?logo=python&logoColor=white)](https://www.python.org/downloads/release/python-360+/)
 
 # Using Large Language Models to support researchers reproduce and reuse unpublished health care discrete-event simulation computer models: a feasibility and pilot study in Python
 
 ## Authors
 
-* Thomas Monks [![ORCID: Monks](https://img.shields.io/badge/ORCID-0000--0003--2631--4481-brightgreen)](https://orcid.org/0000-0003-2631-4481)
-* Alison Harper [![ORCID: Harper](https://img.shields.io/badge/ORCID-0000--0001--5274--5037-brightgreen)](https://orcid.org/0000-0001-5274-5037)
+* Thomas Monks    [![ORCID: Monks](https://img.shields.io/badge/ORCID-0000--0003--2631--4481-brightgreen)](https://orcid.org/0000-0003-2631-4481)
 
-* Navonil Mustafee [![ORCID: Harper](https://img.shields.io/badge/ORCID-0000--0001--5274--5037-brightgreen)](https://orcid.org/0000-0002-2204-8924)
+* Alison Harper    [![ORCID: Harper](https://img.shields.io/badge/ORCID-0000--0001--5274--5037-brightgreen)](https://orcid.org/0000-0001-5274-5037)
 
-## Creating the virtual environment
+* Amy Heather    [![ORCID: Heather](https://img.shields.io/badge/ORCID-0000--0002--6596--3479-brightgreen)](https://orcid.org/0000-0002-6596-3479)
+
+* Navonil Mustafee    [![ORCID: Mustafee](https://img.shields.io/badge/ORCID-0000--0002--2204--8924-brightgreen)](https://orcid.org/0000-0002-2204-8924)
+
+## Creating the environment
 
 The project uses `conda` to manage dependencies. Navigate your terminal to the directory containing the code
 
 ```
 conda env create -f binder/environment.yml
 ```
 
-This will create a conda virtual environment called `gen_simpy`. To activate:
+This will create a conda environment called `gen_simpy`. To activate:
 
 ```
 conda activate gen_simpy
@@ -36,3 +36,17 @@ jb build .
 ```
 
 This will build the HTML book locally on your machine.  The terminal will display a URL link that you can use to point your browser at the HTML.
+
+## Citation
+
+Please cite this repository as:
+
+> Thomas Monks, Alison Harper, Amy Heather, and Navonil Mustafee. **Using Large Language Models to support researchers reproduce and reuse unpublished health care discrete-event simulation computer models: a feasibility and pilot study in Python**. <https://github.com/pythonhealthdatascience/llm_simpy>.
+
+A `CITATION.cff` file is also provided.
+
+<!--TODO: Archive repository on Zenodo, and cite that -->
+
+## Funding
+
+<!--TODO: Add funding statement-->