From 0a9e79106d8db011613b54f65feb2b002dee7bb4 Mon Sep 17 00:00:00 2001 From: Thomas Bury <36854425+ThomasMBury@users.noreply.github.com> Date: Mon, 29 Aug 2022 15:44:13 -0400 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a2efc32..56adb08 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,35 @@ # restitution-cobweb + +## Description + Dashboard to investigate dynamics of a periodically stimulated cardiac cell based on its restitution function. Displays the restitution function, the iterative map as a cobweb plot, and the APD sequence. Parameters for the simulation and the restitution function may be varied using the sliders. -Launch app here: -https://restitution-cobweb.herokuapp.com/ +The app is currently hosted on Heroku [here](https://restitution-cobweb.herokuapp.com/). + +## Running the app locally + +To run the app on your local computer, clone the repository, create a virtual environment and install the necessary requirements with +``` +pip install --upgrade pip +pip install -r requirements.txt +``` + +Then run the app with +``` +python app.py +``` + +This should show +``` +Dash is running on http://127.0.0.1:8050/ +``` + +You can now visit the app at this URL. + +## Preview + +Screenshot 2022-08-29 at 3 41 27 PM + +