Skip to content

Commit 8e4f73b

Browse files
simplified readme
1 parent 963c175 commit 8e4f73b

File tree

1 file changed

+2
-33
lines changed

1 file changed

+2
-33
lines changed

README.md

Lines changed: 2 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![CI](https://github.com/HYLODE/HyUi/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/HYLODE/HyUi/actions/workflows/main.yml)
22

3-
# Hyperlocal Bed Demand Forecasting (User Interface)
3+
## Welcome to [HYLODE](https://hylode.org)!
44

55
This repository is for Plotly Dash apps within a hospital environment. A
66
template application would be split into a frontend and a backend with
@@ -9,7 +9,7 @@ docker compose.
99

1010
The application code including the backend API in `./api`, and the frontend written in Dash is kept in `./web`.
1111

12-
The documentation is available [here](https://hylode.github.io/HyUi/).
12+
Documentation is available [here](https://hylode.org/developer/setup.html).
1313

1414
## Project Structure
1515

@@ -28,36 +28,5 @@ The documentation is available [here](https://hylode.github.io/HyUi/).
2828
|
2929
```
3030

31-
32-
## Development Environments
33-
34-
### Local Machine
35-
36-
Your own laptop etc. without access to personally identifiable information (PII) etc.
37-
You wish to be able to build and run applications with test data.
38-
39-
Read the docs in `./docs/developer/setup.qmd` to get started.
40-
41-
42-
### Live Machine
43-
44-
An NHS machine or similar within sensitive environment with access to PII.
45-
You wish to be able to deploy the actual application.
46-
47-
## Development workflow
48-
49-
### 1. Make synthetic or mock versions of the data
50-
51-
We imagine that the developer has the appropriate permissions to view the raw data including patient identifiable information (either themselves, or in partnership with a colleague). A justification for this position is [here][http://hylode.github.io/hyui/notes/provisioning.html]. Practically, this means early interactive data exploration using the UCLH Datascience Desktop and similar tools, and in turn access to EMAP and Clarity/Caboodle.
52-
53-
This should generate an initial data specification, and this can be used to generate synthetic data. The synthetic data can then be used to drive the rest of the pathway.
54-
55-
### 2. Develop with synthetic data
56-
57-
### 3. Write some tests and quality control
58-
59-
### 4. Update the plot to run live
60-
61-
6231
**Where this documentation refers to the root folder we mean where this README.md is
6332
located.**

0 commit comments

Comments
 (0)