Merge pull request #50 from DARPA-ASKEM/get-started

Update Getting started topic
DARPA-ASKEM · Jan 24, 2025 · 815c2ac · 815c2ac
2 parents ed00488 + ce77e9a
commit 815c2ac
Show file tree

Hide file tree

Showing 41 changed files with 214 additions and 172 deletions.
diff --git a/docs/config-and-intervention/optimize-intervention-policy.md b/docs/config-and-intervention/optimize-intervention-policy.md
@@ -20,8 +20,6 @@ Given a model configuration and a proposed intervention policy, you can identify
     - The [PyCIEMSS `optimize` interface](https://github.com/ciemss/pyciemss/blob/6a41b1a8247dd76f929488a479f4d27671120b36/pyciemss/interfaces.py#L818).
     - The [PyCIEMSS `optimize` interface notebook](https://github.com/ciemss/pyciemss/blob/main/docs/source/optimize_interface.ipynb).
 
-<!-- <figure markdown>![](../img/models/model-optimize-operator.png)<figcaption markdown>How it works: [PyCIEMSS](https://github.com/ciemss/pyciemss/blob/main/pyciemss/interfaces.py#L747) :octicons-link-external-24:{ alt="External link" title="External link" }</figcaption></figure> -->
-
 ## Create an optimize intervention policy operator
 
 Assuming you have a [model configuration](configure-model.md) and an [intervention policy](create-intervention-policy.md) in your workflow, add an Optimize intervention policy operator: 

diff --git a/docs/config-and-intervention/validate-model-configuration.md b/docs/config-and-intervention/validate-model-configuration.md
@@ -61,7 +61,7 @@ The Validate configuration operator allows you to assess and refine model config
 
 ??? list "Open the Validate configuration operator"
 
-    - Make sure you've connected a model configuration to the Validate configuration operator and then click **Review checks**.
+    - Make sure you've connected a model configuration to the Validate configuration operator and then click **Open**.
 
 ### Use the wizard to validate a model configuration
 

diff --git a/docs/datasets/compare-datasets.md b/docs/datasets/compare-datasets.md
@@ -59,7 +59,7 @@ You can set up your dataset comparison by selecting a baseline and adjusting key
 
 ??? list "Define the comparison"
 
-    1. Select **Compare the impact of interventions**.
+    1. Select **Compare scenarios**.
     2. (Optional) Specify which dataset is the baseline simulation.
     3. (Optional) Select **Average treatment effect** to include a summary of the overall impact of interventions in the resulting comparison tables.
 

diff --git a/docs/datasets/transform-dataset.md b/docs/datasets/transform-dataset.md
@@ -96,7 +96,7 @@ Prompts and responses are written to cells where you can preview, edit, and run
 
 ??? list "Open the Transform dataset code notebook"
 
-    - Make sure you've connected one or more datasets to the Transform dataset operator and then click **Edit**.
+    - Make sure you've connected one or more datasets to the Transform dataset operator and then click **Open**.
 
 ??? list "Rerun a code notebook"
 
@@ -399,7 +399,7 @@ The following sections show examples of how to prompt the Transform dataset AI a
 
     Before you combine datasets, make sure they share at least one common column like name, ID, date, or location. You can ask the AI assistant to link them by matching records based on the common data so that information aligns correctly.
 
-    1. Connect the outputs of each dataset to the input of a Transform dataset operator and then click **Edit**.
+    1. Connect the outputs of each dataset to the input of a Transform dataset operator and then click **Open**.
     2. Ask the assistant to:
 
         ```{ .text .wrap }

diff --git a/docs/get-started/example-workflow.md b/docs/get-started/example-workflow.md
diff --git a/docs/get-started/using-terarium.md b/docs/get-started/using-terarium.md
@@ -126,7 +126,7 @@ Terarium's operators support various ways for you to configure complex scientifi
 ??? list "Use a Terarium operator"
 
     1. Make sure you've connected all the required inputs.
-    1. Click **Open** or **Edit** on the operator node.
+    1. Click **Open** on the operator node.
     2. Switch to the Wizard or Notebook view depending on your preference.
 
         ???+ note

diff --git a/docs/img/get-started/example-compare-datasets.png b/docs/img/get-started/example-compare-datasets.png
diff --git a/docs/img/get-started/example-compare-settings.png b/docs/img/get-started/example-compare-settings.png
diff --git a/docs/img/get-started/example-compare-wizard.png b/docs/img/get-started/example-compare-wizard.png
diff --git a/docs/img/get-started/example-compare-workflow.png b/docs/img/get-started/example-compare-workflow.png
diff --git a/docs/img/get-started/example-dataset-transform-notebook.png b/docs/img/get-started/example-dataset-transform-notebook.png
diff --git a/docs/img/get-started/example-dataset-transform-workflow.png b/docs/img/get-started/example-dataset-transform-workflow.png
diff --git a/docs/img/get-started/example-dataset.png b/docs/img/get-started/example-dataset.png
diff --git a/docs/img/get-started/example-home.png b/docs/img/get-started/example-home.png
diff --git a/docs/img/get-started/example-interventions-dynamic.png b/docs/img/get-started/example-interventions-dynamic.png
diff --git a/docs/img/get-started/example-interventions-optimize-settings.png b/docs/img/get-started/example-interventions-optimize-settings.png
diff --git a/docs/img/get-started/example-interventions-optimized.png b/docs/img/get-started/example-interventions-optimized.png
diff --git a/docs/img/get-started/example-interventions-static.png b/docs/img/get-started/example-interventions-static.png
diff --git a/docs/img/get-started/example-interventions.png b/docs/img/get-started/example-interventions.png
diff --git a/docs/img/get-started/example-model-calibrate-notebook.png b/docs/img/get-started/example-model-calibrate-notebook.png
diff --git a/docs/img/get-started/example-model-calibrate-workflow.png b/docs/img/get-started/example-model-calibrate-workflow.png
diff --git a/docs/img/get-started/example-model-edit-notebook.png b/docs/img/get-started/example-model-edit-notebook.png
diff --git a/docs/img/get-started/example-model-edit-workflow.png b/docs/img/get-started/example-model-edit-workflow.png
diff --git a/docs/img/get-started/example-model-from-equations-notebook.png b/docs/img/get-started/example-model-from-equations-notebook.png
diff --git a/docs/img/get-started/example-model-from-equations-workflow.png b/docs/img/get-started/example-model-from-equations-workflow.png
diff --git a/docs/img/get-started/example-model-stratify-wizard.png b/docs/img/get-started/example-model-stratify-wizard.png
diff --git a/docs/img/get-started/example-model-stratify-workflow.png b/docs/img/get-started/example-model-stratify-workflow.png
diff --git a/docs/img/get-started/example-project-create.png b/docs/img/get-started/example-project-create.png
diff --git a/docs/img/get-started/example-sensitivity-wizard.png b/docs/img/get-started/example-sensitivity-wizard.png
diff --git a/docs/img/get-started/example-sensitivity-workflow.png b/docs/img/get-started/example-sensitivity-workflow.png
diff --git a/docs/img/get-started/example-upload-dataset.png b/docs/img/get-started/example-upload-dataset.png
diff --git a/docs/img/get-started/example-workflow-new.png b/docs/img/get-started/example-workflow-new.png
diff --git a/docs/img/get-started/resources.png b/docs/img/get-started/resources.png
diff --git a/docs/img/models/model-optimize-operator.png b/docs/img/models/model-optimize-operator.png
diff --git a/docs/modeling/create-model-from-equations.md b/docs/modeling/create-model-from-equations.md
@@ -71,7 +71,7 @@ In some cases you may want to change the LaTeX either to correct or and new deta
 
 ??? list "Select equations from a document"
 
-    1. In the workflow, make sure the document is connected to the operator input and then click **Edit**.
+    1. In the workflow, make sure the document is connected to the operator input and then click **Open**.
     2. In the Input panel, review and select the equations you want to include in the model.
 
 ??? list "Edit equations extracted from a document" 

diff --git a/docs/modeling/edit-model.md b/docs/modeling/edit-model.md
@@ -79,7 +79,7 @@ Generated code appears below your prompts, where you can preview, edit, and run
 
 ??? list "Open the Edit model code notebook"
 
-    - Make sure you've connected a model or model configuration to the Edit model operator and then click **Edit**.
+    - Make sure you've connected a model or model configuration to the Edit model operator and then click **Open**.
 
 ### Use the AI assistant to edit a model
 

diff --git a/docs/modeling/index.md b/docs/modeling/index.md
@@ -51,7 +51,7 @@ In a workflow graph, a model resource shows its underlying diagram or equations.
 ??? list "Copy a model"
 
     1. Add the Model operator to a workflow graph and connect it to an Edit model operator.
-    2. Click **Edit** on the Edit model operator.
+    2. Click **Open** on the Edit model operator.
     3. Click **Save for re-use**, enter a name for the copy, and click **Save**.
 
 ### What can I do with a model resource?

diff --git a/docs/modeling/stratify-model.md b/docs/modeling/stratify-model.md
@@ -51,7 +51,7 @@ The Stratify model operator adapts to your level of coding experience. You can s
 
 ??? list "Open the Stratify model operator"
 
-    - Make sure you've connected a model or model configuration to the Stratify model operator and then click **Edit**.
+    - Make sure you've connected a model or model configuration to the Stratify model operator and then click **Open**.
 
 ### Use the wizard to stratify a model
 

diff --git a/docs/simulation/sensitivity-analysis.md b/docs/simulation/sensitivity-analysis.md
@@ -57,7 +57,7 @@ Once you've built your workflow, you can edit the Simulate run and output settin
 
 ??? list "Conduct a sensitivity analysis"
 
-    1. On the Simulate operator, click **Edit**.
+    1. On the Simulate operator, click **Open**.
     2. Select the Simulate [run settings](../simulation/simulate-model.md).
     3. Click **Run** to start the simulation.
     4. Preview the sensitivity analysis results. To add variables or parameters, use the **Output** settings. 

diff --git a/docs/simulation/simulate-ensemble.md b/docs/simulation/simulate-ensemble.md
@@ -29,9 +29,9 @@ More info coming soon.
     1. [Configure two or more models](../config-and-intervention/configure-model.md).
     2. Right-click anywhere on the workflow graph and select **Simulation** > **Simulate ensemble**.
     3. Connect the Configure model outputs to the Simulate ensemble inputs.
-    4. Click **Edit**.
-    5. Enter custom weights for the model configurations or click **Set weights to be equal** to treat them as equally important.
-    6. Create a mapping between the state variables of the model configurations.
+    4. Click **Open**.
+    5. Create a mapping between the state variables of the model configurations.
+    6. Enter custom weights for the model configurations to specify your confidence in them.
     7. Set the time span:
         - **Start** and **End Step**
         - **Number of samples**

diff --git a/docs/workflows/index.md b/docs/workflows/index.md
@@ -356,7 +356,7 @@ Resources and operators in the workflow graph summarize the data and inputs/outp
 
     Perform one of the following actions:
 
-    - Click **Open** or **Edit**.
+    - Click **Open**.
     - Click <span class="sr-only" id="menu-icon-label">Menu</span> :fontawesome-solid-ellipsis-vertical:{ title="Menu" aria-labelledBy="menu-icon-label" } > :fontawesome-solid-up-right-from-square:{ aria-hidden="true" } **Open in new window**.
 
 ??? list "Duplicate a resource or operator"