You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,10 +16,12 @@ A technical memorandum describing DEMOS is available [here](./DEMOS_Technical_Me
16
16
## Usage
17
17
18
18
### Docker Compose (recommended)
19
-
The latest docker image for demos is stored in `ghcr.io/NatLabRockies/demos:latest`. The input data and configuration file are fed to the container through volumes ([more info about Docker volumes](https://docs.docker.com/engine/storage/volumes/)). We provide a `docker-compose` workflow that can be used to make the process of mounting volumes easier.
19
+
The latest docker image for demos is stored in `ghcr.io/NatLabRockies/demos:latest`. The input data and configuration file are fed to the container through volumes ([more info about Docker volumes](https://docs.docker.com/engine/storage/volumes/)). We provide a `docker-compose` workflow that can be used to make the process of mounting volumes easier. Make sure you have [Docker](https://docs.docker.com/desktop/) and [Docker Compose](https://docs.docker.com/compose/install/) installed before you proceed.
20
+
21
+
The following instructions will guide you through running DEMOS with example data representative of a small area in California. The data and configuration files required to run this example are located in `./data/` and `./configuration` folders. You can change where DEMOS will look for your data following the instructions [in the Docs](https://NatLabRockies.github.io/DEMOS/).
20
22
21
23
#### Clone this repository
22
-
By cloning this repository you download the configuration and data for an example run of DEMOS.
24
+
By cloning this repository you download the configuration and data for an example run of DEMOS. You can also use the `Download ZIP` option available through the green `Code` button above and decompress it to achieve the same results as the clone command.
23
25
24
26
Run the following command in the Terminal App (MacOS) or Command Prompt/PowerShell (Windows):
25
27
```bash
@@ -30,17 +32,13 @@ cd DEMOS
30
32
31
33
# This folder contains (among other files) a data and configuration folder
32
34
# as well as a docker-compose.yml file
33
-
```
34
-
35
-
Make sure you have [Docker](https://docs.docker.com/desktop/) and [Docker Compose](https://docs.docker.com/compose/install/) installed. Now you can run docker as follows:
36
35
37
-
```bash
36
+
# This command runs DEMOS on a docker container
38
37
docker compose up
39
38
```
40
39
#### IMPORTANT for MacOS and Windows users
41
40
> Docker imposes a global limit on how much RAM containers can allocate. DEMOS easily surpases those limits, so in order to run DEMOS in Docker, users need to access the Docker Desktop GUI and `Preferences → Resources → Memory → Increase it (at least 16-20gb)`. The amount of memory required to run DEMOS will primarily depend on the size of the input data.
42
41
43
-
Documentation for custom data requirements, configuration and overall functionality of demos can be found [in the Docs](https://nrel.github.io/DEMOS/).
44
42
45
43
## Other ways to run DEMOS
46
44
@@ -67,6 +65,10 @@ If you prefer to create your own Python environment and run the Python code dire
67
65
pip install .
68
66
```
69
67
68
+
## Comprehensive Documentation
69
+
70
+
Documentation for custom data requirements, configuration and overall functionality of demos can be found [in the Docs](https://NatLabRockies.github.io/DEMOS/).
71
+
70
72
## Contact
71
73
If you have questions, suggestions, or are interested in collaborating, please feel free to reach out or open an issue.
Copy file name to clipboardExpand all lines: docs/source/pages/intro.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,10 +26,12 @@ This document summarizes instructions to install, configure and run DEMOS. Secti
26
26
## 1. Installation
27
27
28
28
### Docker Compose (recommended)
29
-
The latest docker image for demos is stored in `ghcr.io/NatLabRockies/demos:latest`. The input data and configuration file are fed to the container through volumes ([more info about Docker volumes](https://docs.docker.com/engine/storage/volumes/)). We provide a `docker-compose` workflow that can be used to make the process of mounting volumes easier.
29
+
The latest docker image for demos is stored in `ghcr.io/NatLabRockies/demos:latest`. The input data and configuration file are fed to the container through volumes ([more info about Docker volumes](https://docs.docker.com/engine/storage/volumes/)). We provide a `docker-compose` workflow that can be used to make the process of mounting volumes easier. Make sure you have [Docker](https://docs.docker.com/desktop/) and [Docker Compose](https://docs.docker.com/compose/install/) installed before you proceed.
30
+
31
+
The following instructions will guide you through running DEMOS with example data representative of a small area in California. The data and configuration files required to run this example are located in `./data/` and `./configuration` folders. You can change where DEMOS will look for your data following the instructions [in the Docs](https://NatLabRockies.github.io/DEMOS/).
30
32
31
33
#### Clone this repository
32
-
By cloning this repository you download the configuration and data for an example run of DEMOS.
34
+
By cloning this repository you download the configuration and data for an example run of DEMOS. You can also use the `Download ZIP` option available through the green `Code` button in the [GitHub repo](https://github.com/NatLabRockies/DEMOS) and decompress it to achieve the same results as the clone command.
33
35
34
36
Run the following command in the Terminal App (MacOS) or Command Prompt/PowerShell (Windows):
35
37
```bash
@@ -40,14 +42,12 @@ cd DEMOS
40
42
41
43
# This folder contains (among other files) a data and configuration folder
42
44
# as well as a docker-compose.yml file
43
-
```
44
-
45
-
Make sure you have [Docker](https://docs.docker.com/desktop/) and [Docker Compose](https://docs.docker.com/compose/install/) installed. Now you can run docker as follows:
46
45
47
-
```bash
46
+
# This command runs DEMOS on a docker container
48
47
docker compose up
49
48
```
50
49
50
+
51
51
> **Note:**
52
52
> Make sure the Docker Daemon is running. This changes from system to system but Docker Desktop should have a status flag indicating if the daemon is live, if Desktop is available
0 commit comments