Skip to content

Commit eb0791e

Browse files
committed
README: actions gif
1 parent 25ffdf6 commit eb0791e

File tree

4 files changed

+10
-3
lines changed

4 files changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,26 +36,33 @@ In summary, we adapt a textbook example from Nelson (2013): a terminating discre
3636

3737
> *Nelson. B.L. (2013). [Foundations and methods of stochastic simulation](https://www.amazon.co.uk/Foundations-Methods-Stochastic-Simulation-International/dp/1461461596/ref=sr_1_1?dchild=1&keywords=foundations+and+methods+of+stochastic+simulation&qid=1617050801&sr=8-1). Springer.*
3838
39-
## 3. Try the example model in your browser
39+
## 3. Try the example DES in your browser
4040

4141
* Jupyterlab: https://pythonhealthdatascience.github.io/stars-simpy-jupterlite
4242
* Classic notebook: https://pythonhealthdatascience.github.io/stars-simpy-jupterlite/notebooks/?path=01_urgent_care_model.ipynb
4343

4444
## 4. Using the template to create a new repo.
4545

46+
> There are three steps: i.) create a new repo form the template; ii.) modify you repo settings so that GitHub pages are built from Actions. iii.) Commit changes and trigger the GitHub Action and deployment. We recommend reading all instructions first.
47+
4648
Let's assume you wanted to create a new discrete-event simulation model of cancer services.
4749

4850
1. The first step is to copy the template. Click on the green "use this template" button in the top right and select "create a new repository"
4951
2. You will be prompted to enter a name of the repository - e.g. `cancer_model` - and a short description
5052
3. Click on "Create Repository"
5153

52-
![Deploy your own](use_template_1.gif)
54+
![Deploy your own](img/use_template_1.gif)
5355

56+
The JuypterLite interactive website is built from GitHub actions. **In the newly created repo for your model** do the following
5457

58+
4. Navigate to "Settings->Pages"
59+
5. Under "Build and Deployment" set the "Source" to "GitHub actions".
5560

61+
![Deploy your own](img/actions.gif)
5662

63+
By default the build is trigged on any commit to the `main` branch. Push a small commit and it will trigger the build. This will take a few minutes. Your site will be published under https://{USERNAME}.github.io/{DEMO_REPO_NAME}
5764

58-
## 📦 How to install extra packages for your DES model.
65+
## 5. How to install extra packages supporting your DES model. 📦
5966

6067
The repo contains two environment files. To install more dependencies for your DES model and analysis you need to edit the ``environment.yml`` file.
6168

deploy.gif

-1.81 MB
Binary file not shown.

img/actions.gif

939 KB
Loading

0 commit comments

Comments
 (0)