Skip to content

Commit 8403ce0

Browse files
committed
updates to documentation
1 parent c8c905e commit 8403ce0

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@ A technical memorandum describing DEMOS is available [here](./DEMOS_Technical_Me
1616
## Usage
1717

1818
### 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/).
2022

2123
#### 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.
2325

2426
Run the following command in the Terminal App (MacOS) or Command Prompt/PowerShell (Windows):
2527
```bash
@@ -30,17 +32,13 @@ cd DEMOS
3032

3133
# This folder contains (among other files) a data and configuration folder
3234
# 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:
3635

37-
```bash
36+
# This command runs DEMOS on a docker container
3837
docker compose up
3938
```
4039
#### IMPORTANT for MacOS and Windows users
4140
> 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.
4241
43-
Documentation for custom data requirements, configuration and overall functionality of demos can be found [in the Docs](https://nrel.github.io/DEMOS/).
4442

4543
## Other ways to run DEMOS
4644

@@ -67,6 +65,10 @@ If you prefer to create your own Python environment and run the Python code dire
6765
pip install .
6866
```
6967

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+
7072
## Contact
7173
If you have questions, suggestions, or are interested in collaborating, please feel free to reach out or open an issue.
7274
Bingrong Sun: Bingrong.Sun@nlr.gov

docs/source/pages/intro.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,12 @@ This document summarizes instructions to install, configure and run DEMOS. Secti
2626
## 1. Installation
2727

2828
### 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/).
3032

3133
#### 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.
3335

3436
Run the following command in the Terminal App (MacOS) or Command Prompt/PowerShell (Windows):
3537
```bash
@@ -40,14 +42,12 @@ cd DEMOS
4042

4143
# This folder contains (among other files) a data and configuration folder
4244
# 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:
4645

47-
```bash
46+
# This command runs DEMOS on a docker container
4847
docker compose up
4948
```
5049

50+
5151
> **Note:**
5252
> 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
5353

0 commit comments

Comments
 (0)