Skip to content

Commit e6d4683

Browse files
committed
docs(readme): add introduction + emojis + funding statement, and update the title + author list
1 parent d75e883 commit e6d4683

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

README.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,31 @@
11
[![Licence: MIT](https://img.shields.io/badge/Licence-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
22
[![Python 3.10+](https://img.shields.io/badge/-Python_≥_3.10-306998?logo=python&logoColor=white)](https://www.python.org/downloads/release/python-360+/)
33

4-
# 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
4+
<!--TODO: Add DOI badge-->
55

6-
## Authors
6+
# Research Compendium: Replicating Simulations in Python using Generative AI
7+
8+
This repository serves as a **research compendium** for the paper:
9+
10+
> Monks, T., Harper, A., & Heather, A. (2025). **Unlocking the Potential of Past Research: Using Generative AI to Reconstruct Healthcare Simulation Models**. Work in progress. <!--TODO: Add URL-->
11+
12+
A research compendium is collection of all the digital materials relevant to the study. In this case, it includes a description of the aims and models, as well the STRESS reports for each model, the full model code and testing, logs of all the prompts used and experiences working with the LLMs, analysis of the results, and more!
13+
14+
This has been structured into a book which is hosted on GitHub pages and can be viewed at: TBC. <!--TODO: Add URL-->
15+
16+
<br>
17+
18+
## 👥 Authors
719

820
* Thomas Monks &nbsp;&nbsp; [![ORCID: Monks](https://img.shields.io/badge/ORCID-0000--0003--2631--4481-brightgreen)](https://orcid.org/0000-0003-2631-4481)
921

1022
* Alison Harper &nbsp;&nbsp; [![ORCID: Harper](https://img.shields.io/badge/ORCID-0000--0001--5274--5037-brightgreen)](https://orcid.org/0000-0001-5274-5037)
1123

1224
* Amy Heather &nbsp;&nbsp; [![ORCID: Heather](https://img.shields.io/badge/ORCID-0000--0002--6596--3479-brightgreen)](https://orcid.org/0000-0002-6596-3479)
1325

14-
* Navonil Mustafee &nbsp;&nbsp; [![ORCID: Mustafee](https://img.shields.io/badge/ORCID-0000--0002--2204--8924-brightgreen)](https://orcid.org/0000-0002-2204-8924)
26+
<br>
1527

16-
## Creating the environment
28+
## 🌐 Creating the environment
1729

1830
The project uses `conda` to manage dependencies. Navigate your terminal to the directory containing the code
1931

@@ -27,7 +39,9 @@ This will create a conda environment called `gen_simpy`. To activate:
2739
conda activate gen_simpy
2840
```
2941

30-
## Building the Juypter Book
42+
<br>
43+
44+
## 🖥️ Viewing the jupyter book locally
3145

3246
Once in the `gen_simpy` environment, navigate to the top level directory of the code repository in your terminal and issue the following command:
3347

@@ -37,16 +51,22 @@ jb build .
3751

3852
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.
3953

40-
## Citation
54+
<br>
55+
56+
## 📝 Citation
57+
58+
Please cite the archived repository:
59+
60+
> TBC. <!--TODO: Add Zenodo citation-->
4161
42-
Please cite this repository as:
62+
You can also cite this GitHub repository as:
4363

44-
> 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>.
64+
> Thomas Monks, Alison Harper, and Amy Heather. **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>.
4565
4666
A `CITATION.cff` file is also provided.
4767

48-
<!--TODO: Archive repository on Zenodo, and cite that -->
68+
<br>
4969

5070
## Funding
5171

52-
<!--TODO: Add funding statement-->
72+
This project was developed as part of the project STARS: Sharing Tools and Artefacts for Reproducible Simulations. It is supported by the Medical Research Council [grant number [MR/Z503915/1](https://gtr.ukri.org/projects?ref=MR%2FZ503915%2F1)].

0 commit comments

Comments
 (0)