diff --git a/docs/content/page/software-help/context/climate-engine-download.mdx b/docs/content/page/software-help/context/climate-engine-download.mdx new file mode 100644 index 00000000..5a1a3f09 --- /dev/null +++ b/docs/content/page/software-help/context/climate-engine-download.mdx @@ -0,0 +1,7 @@ +--- +title: Climate Engine Data Downoad +banner: true +description: Download geospatial data from the Climate Engine API into your QRiS project. +--- + + [Download Climate Engine Data](/software-help/context/climate-engine-explorer#Downloading-Climate-Engine-Metrics) \ No newline at end of file diff --git a/docs/content/page/software-help/context/climate-engine-explorer.mdx b/docs/content/page/software-help/context/climate-engine-explorer.mdx new file mode 100644 index 00000000..26d6eb9c --- /dev/null +++ b/docs/content/page/software-help/context/climate-engine-explorer.mdx @@ -0,0 +1,59 @@ +--- +title: Climate Engine Explorer +banner: true +description: Explore geospatial data from the Climate Engine API. +--- + +The Climate Engine Explorer is a tool for exploring and downloading climate data from the [Climate Engine API](https://www.climateengine.org/). + +## Accessing the Climate Engine Explorer + +The Climate Engine Explorer can be accessed by right clicking on 'Climate Engine' under the Context Node in the QRiS Project Tree and selecting `Explore Climate Engine`. This will open the Climate Engine Explorer in a new dockable window. + +![Climate Engine Project Tree](/images/software-help/climate-engine/climate-engine-project-tree.png) + +## Downloading Climate Engine Metrics + +The Climate Engine Explorer is based on downloading Climate Engine Timeseries for Sample Frame Polygons. + +1. To begin, navigate to the Climate Engine Metrics Tab and click `Download Metrics`. + + ![Climate Engine Download](/images/software-help/climate-engine/climate-engine-download.png) + +1. Choose the Sample Frame from the dropdown list. Next, check the Sample Frame Features you would like to download metrics for. + +1. Next, select the Climate Engine Metric Dataset from the Dataset dropdown list. After a few seconds, a list of available Variables will populate the Variable checkbox list. Select one or more Variables to download. + +1. Finally, specify the Date Range for the data you would like to download. Common ranges can be selected from the dropdown list, or you can specify a custom range. Note that each Dataset has a different date range of availability. + + **Warning:** Downloading large date ranges can take a long time and may cause QRiS to become unresponsive, especially if there are more than a few sample frame polygons selected. It is recommended to download only the range of data that you need. + +1. Click the `Get Timeseries` button to download the data. A status message will indicate when the data has been downloaded and saved to the project. + +Once the download is complete, you may close the form, or continue to download data for additional datasets, time periods, or sample frame polygons. + +## Exploring Climate Engine Data + +Once you have data downloaded from Climate Engine, you can explore the data in the Climate Engine Explorer. + + ![Climate Engine Sample Frames](/images/software-help/climate-engine/climate-engine-sample-frames.png) + +2. On the Sample Frame Tab on the left panel, select the Sample Frame from the dropdown menu. A list of Sample Frame Features will populate the list below. Check the box next to the Sample Frame Feature(s) you would like to explore. + + **Note:** The the Sample Frame layer will get added to the map for visual reference. As the Sample Frame Features are checked in the Climate Engine Exploer, they will become selected features in the map. This is for visualization purposes only; selecting or deselcting features in the map will not affect the data or visualization in the Climate Engine Explorer. + + ![Climate Engine Metrics](/images/software-help/climate-engine/climate-engine-metrics.png) + +2. On the Climate Engine Metrics Tab, select the metric timeseries you would like to explore. Only one metric can be selected at a time. + +The timeseries plots will appear in the right panel for the selected Sample Frame Feature(s) and Climate Engine Metric. Only timeseries data that has been downloaded for the selected Sample Frame Feature(s) and Climate Engine Metric will be displayed. + +2. You can adjust the date range of the timeseries data by changing the from and to dates at the top of the timeseries plot. + + **Note:** An option for changing the plot type from Time to Space is currently under development and disabled in the current version of the Climate Engine Explorer. + +## Exporting Climate Engine Data + +The Climate Engine Explorer allows you to export the timeseries data for the selected Sample Frame Feature(s) and Climate Engine Metric to a CSV file. + +To export the data, click the `Export` button at the top of the timeseries plot. Select the location where you would like to save the CSV file and click `Save`. \ No newline at end of file diff --git a/docs/static/images/software-help/climate-engine/climate-engine-download.png b/docs/static/images/software-help/climate-engine/climate-engine-download.png new file mode 100644 index 00000000..389c8ac1 Binary files /dev/null and b/docs/static/images/software-help/climate-engine/climate-engine-download.png differ diff --git a/docs/static/images/software-help/climate-engine/climate-engine-metrics.png b/docs/static/images/software-help/climate-engine/climate-engine-metrics.png new file mode 100644 index 00000000..9f306295 Binary files /dev/null and b/docs/static/images/software-help/climate-engine/climate-engine-metrics.png differ diff --git a/docs/static/images/software-help/climate-engine/climate-engine-project-tree.png b/docs/static/images/software-help/climate-engine/climate-engine-project-tree.png new file mode 100644 index 00000000..2c5ff34f Binary files /dev/null and b/docs/static/images/software-help/climate-engine/climate-engine-project-tree.png differ diff --git a/docs/static/images/software-help/climate-engine/climate-engine-sample-frames.png b/docs/static/images/software-help/climate-engine/climate-engine-sample-frames.png new file mode 100644 index 00000000..0f3451e6 Binary files /dev/null and b/docs/static/images/software-help/climate-engine/climate-engine-sample-frames.png differ