diff --git a/CITATION.cff b/CITATION.cff index a136fd3..4524db0 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -27,10 +27,5 @@ authors: 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 diff --git a/README.md b/README.md index b214e57..afa2565 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,21 @@ [![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 +# Research Compendium: Replicating Simulations in Python using Generative AI + +This repository serves as a **research compendium** for the paper: + +> Monks, T., Harper, A., & Heather, A. (2025). **Unlocking the Potential of Past Research: Using Generative AI to Reconstruct Healthcare Simulation Models**. Work in progress. + +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! + +This has been structured into a book which is hosted on GitHub pages and can be viewed at: TBC. + +
+ +## 👥 Authors * Thomas Monks    [![ORCID: Monks](https://img.shields.io/badge/ORCID-0000--0003--2631--4481-brightgreen)](https://orcid.org/0000-0003-2631-4481) @@ -11,9 +23,9 @@ * 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 +## 🌐 Creating the environment The project uses `conda` to manage dependencies. Navigate your terminal to the directory containing the code @@ -27,7 +39,9 @@ This will create a conda environment called `gen_simpy`. To activate: conda activate gen_simpy ``` -## Building the Juypter Book +
+ +## 🖥️ Viewing the jupyter book locally Once in the `gen_simpy` environment, navigate to the top level directory of the code repository in your terminal and issue the following command: @@ -37,16 +51,22 @@ 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 +
+ +## 📝 Citation + +Please cite the archived repository: + +> TBC. -Please cite this repository as: +You can also cite this GitHub 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**. . +> 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**. . A `CITATION.cff` file is also provided. - +
## Funding - \ No newline at end of file +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)]. \ No newline at end of file