Skip to content

Commit

Permalink
Wrapping up the skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
Ritvikj8 committed May 28, 2024
1 parent c0b143d commit 0bdcbb0
Show file tree
Hide file tree
Showing 25 changed files with 91 additions and 17 deletions.
1 change: 1 addition & 0 deletions docs/source/Bad Stuff/Errors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Typical Errors
1 change: 1 addition & 0 deletions docs/source/Bad Stuff/Troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Typical Troubleshooting steps
12 changes: 12 additions & 0 deletions docs/source/Bad Stuff/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Bad Stuff

## Dealing with errors

```{toctree}
:hidden:
Errors
Troubleshooting
```

Errors are a part of doing heavy high-impact computation so do not be discouraged if you encounter them.
3 changes: 3 additions & 0 deletions docs/source/Better Stuff/Output file structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Output file structure

insert picture of what a general results directory looks like
4 changes: 4 additions & 0 deletions docs/source/Better Stuff/Raw Results.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Raw results

Where to find them how to read them etc

3 changes: 3 additions & 0 deletions docs/source/Better Stuff/Results Viewer 101.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Results Viewer 101

A very high level overview of the functionality of the RV
4 changes: 4 additions & 0 deletions docs/source/Better Stuff/Summary Results.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Summary Results

What are they where to find them

11 changes: 11 additions & 0 deletions docs/source/Better Stuff/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Better Stuff

```{toctree}
:hidden:
Results Viewer 101
Output file structure
Summary Results
Raw Results
```
This section will go through the process of Running and viewing results.
1 change: 1 addition & 0 deletions docs/source/FAQs/FAQ Case Settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# FAQ on Case Settings
1 change: 1 addition & 0 deletions docs/source/FAQs/FAQ RV.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# FAQ on the RV
1 change: 1 addition & 0 deletions docs/source/FAQs/FAQ Running model.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# FAQ on Running Resolve
12 changes: 12 additions & 0 deletions docs/source/FAQs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# FAQs

```{toctree}
:hidden:
FAQ Case Settings
FAQ Running model
FAQ RV
```
This section will cover FAQs in detail


1 change: 1 addition & 0 deletions docs/source/Good Stuff/Cmd Line.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Run from command Line
1 change: 1 addition & 0 deletions docs/source/Good Stuff/Excel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Run from Excel
11 changes: 11 additions & 0 deletions docs/source/Good Stuff/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Good Stuff

```{toctree}
:hidden:
Cmd Line
Excel
```


This will cover how to run RESOLVE
1 change: 1 addition & 0 deletions docs/source/Setting up cases/Case Settings Tab.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Case Settings Tab
1 change: 1 addition & 0 deletions docs/source/Setting up cases/Configuring Case Settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# # Configuring Case Settings
1 change: 1 addition & 0 deletions docs/source/Setting up cases/Configuring Systems.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Configuring Systems
1 change: 1 addition & 0 deletions docs/source/Setting up cases/Configuring scenarios.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Configuring Scenarios
Empty file.
1 change: 1 addition & 0 deletions docs/source/Setting up cases/Running Macros.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Running Macros
13 changes: 13 additions & 0 deletions docs/source/Setting up cases/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Setting up cases

```{toctree}
:hidden:
Configuring Case Settings
Configuring scenarios
Configuring Systems
Case Settings Tab
Running Macros
```

This section will walk you through on how to set up cases
3 changes: 1 addition & 2 deletions docs/source/World of Scenario Tool/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,4 @@ Experimenting with the Scenario Tool
```


(saving-inputs)=
## Saving Input Data & Case Settings
Welcome to the crazy world of the Scenario Tool
12 changes: 0 additions & 12 deletions docs/source/definitions_test.md

This file was deleted.

8 changes: 5 additions & 3 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,11 @@ explore how we can run this remarkable model and plan systems for the future.
getting_started/index
Initial Model Set-Up/index
World of Scenario Tool/index
user_guide/index
running_resolve
viewing_results
Setting up cases/index
Good Stuff/index
Better Stuff/index
Bad Stuff/index
FAQs/index
```

Expand Down

0 comments on commit 0bdcbb0

Please sign in to comment.