Merge pull request #25 from pythonhealthdatascience/dev

DEV: added changelog

Author: TomMonks

CHANGES.md

@@ -0,0 +1,61 @@
+# Change Log
+
+## v3.0.0
+
+22nd April 2024
+
+* ENV: `plotly` v5.21.0 added.
+* ENV: Arrival rate and MORE plot have been migrated to be interactive `plotly` format.  
+* MODULE: `more_plot.py` updated to include a `more_plotly` function.
+* PAGES: Multiple replications setting moved from side bar to main window and converted to text input in 🎱 Interactive Simulation page.
+* PAGES: Creation of Resources app page. Migration of Links from About page.
+* PAGES: Creation of Changes app page: logging all major, minor and patched releases of the app.
+* PAGES: About page cleaned up and linked to STARS main study and team.
+* PAGES: Emojis 😀 added to app internal page names
+
+## v2.2.0
+
+20th April 2024
+
+* PAGES: Introduce of License page 
+* PAGES: Links to GitHub, Zenodo archive, Documentation and Tutorial material added to About Page
+* ENV: Upgrade `streamlit` to 1.33.0
+* ENV: Upgrade `simpy` to 4.1.1
+
+## v2.1.0
+
+8th March 2024
+
+* SIM: Upgraded internal implementation of generating non-overlapping random number streams.  This is now implemented to use `np.random.SeedSequence`. See https://numpy.org/doc/stable/reference/random/parallel.html 
+* PATCH: Removed deprecated use of st.@cache decorator.
+
+## v2.0.0
+
+1st March 2024
+
+* ENV: Upgraded to Python 3.10 and upgrade `numpy`, `pandas`, `matplotlib`` versions etc.
+* ENV: Upgraded to streamlit `1.31.1`
+* PAGES: Removed deprecated `streamlit`` functions
+* PATCH: Fixed `st.setup_page` location in `Overview.py` (main landing page) to avoid runtime error.
+
+## v1.2.0
+
+30th October 2023
+
+* Updated pilot Web App release to support *Toward Sharing Tools and Artefacts for Reusable Simulations in Healthcare* project.
+* GITHUB: Included detailed instructions to download the code, install dependencies and run the app locally
+* GITHUB: Updated README URLs and included link to SW23 version of app redundancy.
+
+## v1.1.0
+
+23rd January 2023
+
+* Added Dockerfile that creates a python:3.8 image running the latest version of streamlit and the app on port 8989.
+
+## v1.0.0
+
+19th July 2022
+
+* Pilot Web App release to test project feasibility.
+* The release supports [conference paper](https://www.theorsociety.com/media/7313/doiorg1036819sw23030.pdf) and talk given at the OR Society Simulation Workshop 2023 (SW23) 
+* Code can be found in separate repository: 

pages/0_🎱_Interactive_simulation.py

@@ -58,7 +58,7 @@ def get_arrival_chart():
     fig = px.bar(arrivals, x='period', y='arrival_rate',
                  labels={
                     "period": "hour of day",
-                    "arrival_rate": "mean arrivaks"
+                    "arrival_rate": "mean arrivals"
                  })
 
     return fig

pages/7_🗒️_Change_Log.py

@@ -0,0 +1,38 @@
+'''
+Change log page
+
+A list of changes to each version of the app
+'''
+
+import streamlit as st
+import urllib.request as request
+
+FILE = (
+    "https://raw.githubusercontent.com/pythonhealthdatascience/"
+    + "stars-streamlit-example/main/CHANGES.md"
+)
+
+
+def read_file_contents(path):
+    """
+    Download the content of a file from the GitHub Repo and return as a utf-8 string
+
+    Notes:
+    -------
+        adapted from 'https://github.com/streamlit/demo-self-driving'
+
+    Parameters:
+    ----------
+    path: str
+        e.g. file_name.md
+
+    Returns:
+    --------
+    utf-8 str
+
+    """
+    response = request.urlopen(path)
+    return response.read().decode("utf-8")
+
+
+st.markdown(read_file_contents(FILE))