Skip to content

Commit

Permalink
Readme updates (#36)
Browse files Browse the repository at this point in the history
* Update README - Adds codeblock highlighting
* Update README - git clone to CloudInfra
* Update README - shorten mkdir commands
* Update README - add cd command
* README.md - Update clone directory
---------

Co-authored-by: Arpita Patel <[email protected]>
  • Loading branch information
JoshCu and arpita0911patel authored Oct 24, 2023
1 parent 9e7e02a commit 4334f51
Showing 1 changed file with 14 additions and 16 deletions.
30 changes: 14 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ This repository contains :
1. Open **PowerShell** as an administrator.

2. Run the following command to enable WSL feature:
```
```powershell
wsl --install
```
Expand Down Expand Up @@ -77,11 +77,9 @@ This repository contains :
#### Linux & Mac & WSL
```Linux
$ mkdir NextGen
$ cd NextGen
$ mkdir ngen-data
$ cd ngen-data
```bash
$ mkdir -p NextGen/ngen-data
$ cd NextGen/ngen-data
$ wget --no-parent https://ciroh-ua-ngen-data.s3.us-east-2.amazonaws.com/AWI-001/AWI_03W_113060_001.tar.gz
$ tar -xf AWI_03W_113060_001.tar.gz
$ cd AWI_03W_113060_001
Expand All @@ -91,7 +89,7 @@ This repository contains :
#### Windows Steps:
#### Note: It is recommended to use WSL and follow [instructions for Linux & Mac & WSL](#Linux-&-Mac-&-WSL-)

```Windows
```powershell
$ mkdir NextGen
$ cd NextGen
$ mkdir ngen-data
Expand All @@ -107,7 +105,8 @@ This repository contains :

Navigate to NextGen directory and clone the repo using below commands:

```
```bash
$ cd ../..
$ git clone https://github.com/CIROH-UA/NGIAB-CloudInfra.git

$ cd NGIAB-CloudInfra
Expand All @@ -118,10 +117,9 @@ Once you are in *CloudInfra* directory, you should see `guide.sh` in it. Now, we

#### WSL, Linux and Mac Steps:
Follow below steps to run `guide.sh` script
```
# Note: Make sure you are in ~/Documents/NextGen/NGIAB-CloudInfra directory
$ ./guide.sh

```bash
$ ./guide.sh
```
### Output of the model guide script

Expand All @@ -132,14 +130,14 @@ Follow below steps to run `guide.sh` script
Run the following command based on your OS and copy the path value:

**Windows:**
```
```powershell
C:> cd ~\<path>\NextGen\ngen-data
c:> pwd
and copy the path
```

**Linux/Mac:**
```
```bash
$ cd ~/<path>/NextGen/ngen-data
$ pwd
and copy the path
Expand All @@ -159,7 +157,7 @@ For x86 machines, it pulls awiciroh/ciroh-ngen-image:latest-x86.
- If the user selects the catchment, nexus, and realization files they want to use.

Example NGEN run command for parallel mode:
```
```bash
mpirun -n 2 /dmod/bin/ngen-parallel
/ngen/ngen/data/config/catchments.geojson ""
/ngen/ngen/data/config/nexus.geojson ""
Expand All @@ -169,7 +167,7 @@ mpirun -n 2 /dmod/bin/ngen-parallel
- If the user selects serial mode, the script runs the model directly.

Example NGEN run command for serial mode:
```
```bash
/dmod/bin/ngen-serial
/ngen/ngen/data/config/catchments.geojson ""
/ngen/ngen/data/config/nexus.geojson ""
Expand Down

0 comments on commit 4334f51

Please sign in to comment.