Skip to content

Commit

Permalink
added links to general concepts
Browse files Browse the repository at this point in the history
  • Loading branch information
clarasb committed Nov 19, 2024
1 parent caea7f8 commit e699d49
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
12 changes: 6 additions & 6 deletions docs/user_guide/analyse.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The Viewer provides the ability to extract information from variables at [select

### Time-Series

When adding a new place to the map, a time series will automatically be extracted and displayed by default. To display a time series for an already existing place, simply select it and use the _graph_-icon next to the variables drop-down menu.
When [adding a new place](#create) to the map, a time series will automatically be extracted and displayed by default. To display a time series for an already existing place, simply select it and use the _graph_-icon next to the variables drop-down menu.

To remove a place from a graph, click the `-`-icon next to the place listed below the graph. The color of a place corresponds to the color in the time series graphs. The coordinates of the places visualized in the time series can be found beneath the graphs.

Expand Down Expand Up @@ -67,7 +67,7 @@ For point places:

Define your own variables computed from Python-like expressions. The expressions can combine other variables of the [current dataset](../concepts.md/#selected-dataset) using almost all Python operators and all [numpy universal functions](https://numpy.org/doc/stable/reference/ufuncs.html#available-ufuncs). User data variables are persisted in the browser's local storage.

???+ info "In more detail"
??? info "In more detail"

A _user variable_ is a variable that is defined by a _name_, _title_, _units_,
and by an algebraic _expression_ that is used to compute the variable's array
Expand Down Expand Up @@ -115,7 +115,7 @@ Define your own variables computed from Python-like expressions. The expressions

## Compare Variables

Visually compare two variables using **Compare Mode**. This mode displays two variables side by side, with a slider in the middle that can be adjusted.
Visually compare two [variables](../concepts.md/#variable) using **Compare Mode**. This mode displays two variables side by side, with a slider in the middle that can be adjusted.

![Compare Mode](../assets/videos/analysis_compare-mode.gif)

Expand All @@ -133,11 +133,11 @@ To **exit** Compare Mode: use the button on the left
![Player](../assets/images/analysis_player_light.png){: class="light-image" }
![Player](../assets/images/analysis_player_dark.png){: class="dark-image" }

Use the shown features of the Viewer to navigate through the time steps of a variable. Select a specific date in the calendar view, move through the dataset time step by time step, jump to the beginning or end of the dataset, move the slider on the bar to select a time step, or start the player.
Use the shown features of the Viewer to navigate through the time steps of a [variable](../concepts.md/#variable). Select a specific date in the calendar view, move through the dataset time step by time step, jump to the beginning or end of the dataset, move the slider on the bar to select a time step, or start the player.

### The Player

Use the player to auto-step through the variable of a dataset. The interval can be adjusted in the [settings](settings.md/#player-interval).
Use the player to auto-step through the [variable](../concepts.md/#variable) of a [dataset](../concepts.md/#dataset). The interval can be adjusted in the [settings](settings.md/#player-interval).

![Player](../assets/videos/Player_hh.gif)

Expand All @@ -160,7 +160,7 @@ New [places](../concepts.md/#places-and-place-groups) can be **created** in the

### Import

Externally created [places](../concepts.md/#places-and-place-groups) can also be **imported**. The allowed formats are `text/csv`, `GeoJSON` and `WKT`. When importing a CSV table or a GeoJSON object, user can specify the time column name or time property. If given, time values are expected to be UTC and use ISO format.
Externally created [places](../concepts.md/#places-and-place-groups) can also be **imported**. The allowed formats are `text/csv`, `GeoJSON` and `WKT`. When importing a CSV table or a GeoJSON object, the time column name or time property can be specified. If given, time values are expected to be UTC and ISO format.

![Import Places](../assets/images/analysis_import_places.png)

Expand Down
14 changes: 7 additions & 7 deletions docs/user_guide/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ The Viewer gives the option to display the datasets in front of a [base map](../

![Datamanagement - Layer Visibilities](../assets/images/datamanagement_visibility_added.png){ align=right }

The draggable Layer Visibility Menu can be opened on the left-hand side of the viewer. The menu can be used to control the display and hiding of the following objects:
The draggable Layer Visibility Menu can be opened on the left-hand side of the viewer. The menu can be used to control the display and hiding of the following [layers](../concepts.md/#layers):

- selected Variable
- pinned Variable (marked by icon)
- User and Dataset Places
- Base Map and Overlay
- [Selected Variable](../concepts.md/#variable-layer)
- [Pinned Variable](../concepts.md/#pinned-variable) (marked by icon)
- User and Dataset [Places](../concepts.md/#places-and-place-groups)
- [Base Map and Overlay](../concepts.md/#basemaps-and-overlays)
- boundary box of the selected Dataset
- RGB of Dataset (selected and pinned)
- [RGB of Dataset](../concepts.md/#dataset-rgb-layer) (selected and pinned)

User Base Maps and User Overlays can also be added here.

Expand All @@ -40,7 +40,7 @@ User Base Maps and User Overlays can also be added here.

![Metadata](../assets/images/datamanagement_meta.png){ align=left }

The metadata information is accessible through a tab in the sidebar, which can be displayed using a button on the right side of the Viewer [1]. This section displays metadata for the selected dataset, variable, or location. The visibility of this information can be enabled at the top left [2].
The metadata information is accessible through a tab in the sidebar, which can be displayed using a button on the right side of the Viewer [1]. This section displays metadata for the [selected dataset](../concepts.md/#selected-dataset), [variable](../concepts.md/#selected-variable), or [location](../concepts.md/#selected-place). The visibility of this information can be enabled at the top left [2].

The metadata can be displayed in three different formats:

Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Adjust the **base map** and **overlays**, choose the **projection** (_Geographic

### Base maps and Overlays

The Viewer allows you to display datasets over a [Base Map](../concepts.md/#basemaps-and-overlays) and [overlay](../concepts.md/#basemaps-and-overlays) them with additional information, such as transportation routes or place names. A large number of base maps and overlay layers are already integrated in the Viewer. Others can be selected by clicking on `Base map` or `Overlay`.
The Viewer allows you to display datasets over a [base map](../concepts.md/#basemaps-and-overlays) and [overlay](../concepts.md/#basemaps-and-overlays) them with additional information, such as transportation routes or place names. A large number of base maps and overlay layers are already integrated in the Viewer. Others can be selected by clicking on `Base map` or `Overlay`.

![Settings - Maps - Overlay](../assets/images/settings_overlay.png)

Expand All @@ -48,7 +48,7 @@ The Viewer allows you to display datasets over a [Base Map](../concepts.md/#base

![On Selection](../assets/images/settings_on_selection.png)

The map extent can be changed when [selecting](../concepts.md/#selections) a new Dataset or Place. The following options are available:
The map extent can be changed when [selecting](../concepts.md/#selections) a new [dataset](../concepts.md/#selected-dataset) or [place](../concepts.md/#selected-place). The following options are available:

- `pan` : map moves to the center of dataset bounding box
- `pan and zoom`: map moves to the center and zooms to the extent of the dataset
Expand Down

0 comments on commit e699d49

Please sign in to comment.