Skip to content

Commit 2ea6799

Browse files
committed
docs(llm_simpy): update title of llm_simpy repository (+ add line breaks and DOI badge to README)
1 parent 4567fcd commit 2ea6799

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

Home.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@
1212
"""
1313
This application is complementary to:
1414
15-
> Thomas Monks, Alison Harper, and Amy Heather. **Using Large
16-
Language Models to support researchers reproduce and reuse unpublished health
17-
care discrete-event simulation computer models: a feasibility and pilot study
18-
in Python**. https://github.com/pythonhealthdatascience/llm_simpy.
15+
> Thomas Monks, Alison Harper, and Amy Heather. **Research Compendium:
16+
Replicating Simulations in Python using Generative AI**.
17+
https://github.com/pythonhealthdatascience/llm_simpy.
1918
2019
It deploys the streamlit applications generated using Perplexity as a single
2120
app via stlite and GitHub pages.

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
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+/)
3+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15082494.svg)](https://doi.org/10.5281/zenodo.15082494)
34

45
# Complementary repository: Final discrete-event simulation models and streamlit applications from Large Language Models
56

67
This repository is complementary to:
78

8-
> 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.
9+
> Thomas Monks, Alison Harper, and Amy Heather. **Research Compendium: Replicating Simulations in Python using Generative AI**. https://github.com/pythonhealthdatascience/llm_simpy.
910
1011
It contains the final formatted code from each of the SimPy discrete-event simulation models that were generated by Perplexity as part of that project.
1112

@@ -24,6 +25,8 @@ The stroke `.py` files combine the seperate model and app .py files from the [ll
2425

2526
For a full record of the generation of these models, please refer to: https://github.com/pythonhealthdatascience/llm_simpy.
2627

28+
<br>
29+
2730
## 👥 Authors
2831

2932
* Thomas Monks &nbsp;&nbsp; [![ORCID: Monks](https://img.shields.io/badge/ORCID-0000--0003--2631--4481-brightgreen)](https://orcid.org/0000-0003-2631-4481)
@@ -32,6 +35,8 @@ For a full record of the generation of these models, please refer to: https://gi
3235

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

38+
<br>
39+
3540
## 🌐 Creating the environment
3641

3742
The project uses `conda` to manage dependencies. Navigate your terminal to the directory containing the code and run:
@@ -48,6 +53,8 @@ conda activate gen_simpy_apps
4853

4954
This environment is a simplified version of that from the [llm_simpy](https://github.com/pythonhealthdatascience/llm_simpy) repository, containing only the dependencies required for running the apps.
5055

56+
<br>
57+
5158
## 🖥️ Viewing the apps locally
5259

5360
For deployment, we have brought the LLM-generated apps together into a single app, which can be deployed by running:
@@ -68,6 +75,8 @@ To test the stlite app locally, run the following command, and then open <http:/
6875
python3 -m http.server
6976
```
7077

78+
<br>
79+
7180
## 📝 Citation
7281

7382
Please cite the archived repository:
@@ -80,6 +89,8 @@ You can also cite this GitHub repository as:
8089
8190
A `CITATION.cff` file is also provided.
8291

92+
<br>
93+
8394
## 💰 Funding
8495

8596
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)