Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/images/image-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/image-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/image-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/image-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/image-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/image-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/images/project-landfire-tab-opened.png
Binary file not shown.
Binary file removed docs/assets/images/scenario-landfire-tab-opened.png
Binary file not shown.
Binary file removed docs/assets/images/scenario-landfire-tab.png
Binary file not shown.
27 changes: 17 additions & 10 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,38 +14,45 @@ This tutorial will provide a brief overview of:

## Installing required packages

Download and install [SyncroSim version 2.2.19](https://syncrosim.com/download/){:target="_blank"} or higher and follow the installation prompts.
Download and install [SyncroSim version 3.1.25](https://syncrosim.com/download/){:target="_blank"} or higher and follow the installation prompts.

Open SyncroSim and select **File > Packages… > Install**. Then, mark the check-boxes beside the **stsim** and **landfirevegmodels** packages and click OK.
Open SyncroSim and select **File > Local Packages… > Install from Server**. Then, mark the check-boxes beside the **stsim** (version 4.5.3 or later).

You may need to update the **stsim** package to version 3.2.21 or later. To do so, select **File > Packages > Update...**, mark the check-box beside the **stsim** package and click **OK**.
<img align="middle" style="padding: 1px" width="500" src="assets/images/image-1.png">

<img align="middle" style="padding: 1px" width="500" src="assets/images/image-2.png">

Repeat the same process for **landfirevegmodels** (version 2.0.0).

<img align="middle" style="padding: 1px" width="500" src="assets/images/image-3.png">
Comment on lines +21 to +27

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add alt text to the screenshots. These instructional images are missing alt text, which hurts screen readers and keeps the markdownlint MD045 warnings alive.

Also applies to: 44-50

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 21-21: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 23-23: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 27-27: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/getting_started.md` around lines 21 - 27, Add meaningful alt text
attributes to the <img> tags shown (assets/images/image-1.png, image-2.png,
image-3.png) to satisfy accessibility and markdownlint MD045; update each tag in
docs/getting_started.md to include descriptive alt strings (e.g.,
alt="Screenshot: <brief description>") and do the same for the other images
referenced around lines 44-50 so all instructional screenshots have appropriate
alt text.

Source: Linters/SAST tools

<br>

## Creating a new **landfirevegmodels** Library

In SyncroSim, select **File > New...**.
In SyncroSim, select **File > New > From Online Template...**.

Select the **landfirevegmodels** base package and choose either the **Reference Models** or **Example Models** template library.
Select the **landfirevegmodels** package and choose either the **CONUS and HI Reference Conditions** for continental U.S. and Hawaii models or the **Alaska Reference Conditions** for models of Alaska.

Enter a **Filename** or keep the default, select a **Folder** for your new library, and click **OK**. A download window should appear and your library will be created from an online template.

<br>

## Configuring the Library

Right-click on the Project datafeed (*i.e.*, **Definitions**) and select **Properties**. Navigate to the **Landfire** tab, where you can specify details about the quantity, type, and composition of the vegetation for your model.
Right-click on the Project datafeed (*i.e.*, **BpSModels**) and select **Open** (or **double-click** on BpSModels). Navigate to the **LANDFIRE vegetation models** tab, where you can specify details about the quantity, type, and composition of the vegetation for your model.

<img align="middle" style="padding: 1px" width="500" src="assets/images/image-4">

<img align="middle" style="padding: 1px" width="500" src="assets/images/project-landfire-tab-opened.png">
Open the Scenario datafeed (*i.e.*, the LANDFIRE BpS Reference Condition Models). Navigate to the **LANDFIRE vegetation models** tab, where you can provide further information about the model, including detailed **Succession Class Descriptions** and **Succession Class Mapping Rules**.

Right-click on the Scenario datafeed (*i.e.*, the Scenario name) and select **Properties**. Navigate to the **Landfire** tab, where you can provide further information about the model, including detailed **Succession Class Descriptions** and **Succession Class Mapping Rules**.
<img align="middle" style="padding: 1px" width="500" src="assets/images/image-5">

<img align="middle" style="padding: 1px" width="500" src="assets/images/scenario-landfire-tab-opened.png">
<img align="middle" style="padding: 1px" width="500" src="assets/images/image-6">

<br>

## Learn more

For documentation on the SyncroSim user interface see the SyncroSim [Getting Started](http://docs.syncrosim.com/getting_started/quickstart.html){:target="_blank"} page.

**landfirevegmodels** is a wrapper for ST-Sim. For more information on ST-Sim, see its [documentation](http://docs.stsim.net/){:target="_blank"}.
**landfirevegmodels** runs on ST-Sim. For more information on ST-Sim, see its [documentation](http://docs.stsim.net/){:target="_blank"}.
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ permalink: /

## Vegetation dynamics modeling framework

### **landfirevegmodels** is a SyncroSim base package to deliver LANDFIRE state-and-transition simulation models of vegetation, based on reference conditions for the U.S. The package is a wrapper for the [ST-Sim](http://docs.stsim.net/){:target="_blank"} package in SyncroSim.
### **landfirevegmodels** is a SyncroSim package that delivers pre-built [LANDFIRE](https://landfire.gov/){:target="_blank"} state-and-transition models of vegetation dynamics for ecosystems across the United States.

The **landfirevegmodels** package contains hundreds of state-and-transition simulation models (STSMs) of Biophysical Settings (BpS), designed by The Nature Conservancy's LANDFIRE program in collaboration with experts across the United States. These BpS models are reference condition models depicting what ecosystems may have looked like prior to European colonization of North America. The purpose of the **landfirevegmodels** package is to provide baseline models that can be modified to represent current landscapes and used to forecast the effects of ecosystem disturbances and/or management actions through simulations.
The models included in the **landfirevegmodels** package contains hundreds of state-and-transition simulation models (STSMs) of Biophysical Settings (BpS), designed by The Nature Conservancy's LANDFIRE program in collaboration with experts across the United States. These BpS models are reference condition models depicting what ecosystems may have looked like prior to European colonization of North America. The purpose of the **landfirevegmodels** package is to provide baseline models that can be modified to represent current landscapes and used to forecast the effects of ecosystem disturbances and/or management actions through simulations. Built on top of ST-Sim, the package comes with the models already constructed so you can focus on modifying and applying them to your area of interest rather than building from scratch.

For more information on how these types of models can be used for assessing the state of the current landscape, as well as planning for management action based on simulated future landscapes, see [Blankenship et al., 2021](https://esajournals.onlinelibrary.wiley.com/doi/10.1002/ecs2.3484){:target="_blank"}.

<br>

## Requirements

This package requires the [SyncroSim version 2.2.19](https://syncrosim.com/download/){:target="_blank"} or higher.
This package requires the [SyncroSim version 3.1.25](https://syncrosim.com/download/){:target="_blank"} or newer.

<br>

Expand All @@ -47,6 +47,6 @@ Read the accompanying scientific publication at

## Developers

[The Nature Conservancy LANDFIRE team](https://www.conservationgateway.org/ConservationPractices/FireLandscapes/LANDFIRE/contacts/Pages/default.aspx){:target="_blank"}
[The Nature Conservancy LANDFIRE team](https://storymaps.arcgis.com/stories/f37983671094430ebd23035596deccb6){:target="_blank"}
<br>
[ApexRMS](https://apexrms.com/people/){:target="_blank"}