Skip to content

Commit fd5098d

Browse files
authored
Cleanup
1 parent af6d12e commit fd5098d

7 files changed

Lines changed: 41 additions & 28 deletions

File tree

docs/data-service/accessing-data.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Imagine you are managing water resources or monitoring flood risks in a specific
1010

1111
## Understanding Predictive Limits with the Model Skill Tab
1212

13-
You can navigate to the Model Skill tab to evaluate a model’s overarching behavior during its most recent run. While the Score Card ranks localized, multi day performance, the Model Skill tab provides an immediate, CONUS wide snapshot of a single, freshly completed forecast. By checking the national Observation vs. Simulation scatter plot, you can instantly spot systematic biases such as a universal tendency to underpredict major flood events. Meanwhile, the Spatial Error (MAE) map highlights exactly where across the country the model struggled or succeeded, providing critical context on how the model reacts to the current day's specific weather patterns.
13+
You can navigate to the Model Skill tab to evaluate a model’s overarching behavior during its most recent run. While the Score Card ranks localized, multi-day performance, the Model Skill tab provides an immediate, COntiguous United States (CONUS-wide) snapshot of a single, freshly completed forecast. By checking the national Observation vs. Simulation scatter plot, you can instantly spot systematic biases such as a universal tendency to underpredict major flood events. Meanwhile, the Spatial Error (MAE) map highlights exactly where across the country the model struggled or succeeded, providing critical context on how the model reacts to the current day's specific weather patterns.
1414

1515
![](/img/model_behavior.png)
1616

@@ -22,7 +22,7 @@ Once you know which model to look at, the KGE Decomposition Radar Plots tell you
2222

2323
# Accessing Hydro Forecast Data
2424

25-
The Lynker Spatial data portal exposes key hydro-intellegence that is [accessable programatically](https://flowfabric-api.lynker-spatial.com/) using domain standard data standards such as zarr and parquet. We also provide more user friendly aceess tools via the [flowfabric-r](https://lynker-spatial.github.io/flowfabric-r/) or [flowfabric-py](https://lynker-spatial.github.io/flowfabric-py/) packages, see the dedicated documenation pages within the individual package pages for more details.
25+
The Lynker Spatial data portal exposes key hydro-intelligence that is [acaccessible programmatically](https://flowfabric-api.lynker-spatial.com/) using domain standard data standards such as zarr and parquet. We also provide more user-friendly access tools via the [flowfabric-r](https://lynker-spatial.github.io/flowfabric-r/) or [flowfabric-py](https://lynker-spatial.github.io/flowfabric-py/) packages, see the dedicated documentation pages within the individual package pages for more details.
2626

2727
![](/img/Flowfabric_packages.png)
2828

docs/data-service/authentication.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,8 @@ gdalinfo -ro -so "https://proxy.lynker-spatial.com/.../data.zarr"
7474

7575
:::::
7676

77+
## Usage limits
78+
79+
We provide a generouse (5 gig) usage limit on these services that refreshes monthly. To check how much you've used, navigate to [https://flowfabric-api.lynker-spatial.com/v1/me](https://flowfabric-api.lynker-spatial.com/v1/me).
80+
7781
Now that you know how to get authenticated, [see how you access the data](/data-service/accessing-data.md).

docs/data-service/fim.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@
44

55
## Background:
66

7-
As a confluence of domains, Flood Inundation Mapping (FIM) borrows workflows and terminologies across several different disciplines, and a shared vocabulary is critical to being able to efficiently communicate the choices and distinctions between the various ways we map a flood. Here we'll outline the critical ones we've exposed in the [FloodFabric application](https://floodfabric.lynker-spatial.com/).
7+
As a confluence of domains, Flood Inundation Mapping (FIM) borrows workflows and terminologies across several different disciplines, and a shared vocabulary is critical to being able to efficiently communicate the choices and distinctions between the various ways we map a flood. Here we'll outline the critical ones we've exposed in the .
8+
9+
Flood Inundation Mapping (FIM) sits at the confluence of several domains, borrowing workflows and terminology from multiple disciplines. A shared vocabulary is critical to effectively communicate the distinctions and choices involved in various mapping methods. This section outlines the core concepts integrated into the [FloodFabric application](https://floodfabric.lynker-spatial.com/).
810

911
### Library terminology:
1012

11-
A FIM library is used to denote a given database. Each of these databases are composed of and parsed out in their own particular wway, which are refer to as volumes. FloodFabric takes care of these differences, harmonizing the various voulmes into easily distinguisahble flood library access patterns which are selectable in the menu on the left hand side of the dashboard. At the current moment, you can select the [National Water Model HAND libraries](https://github.com/NOAA-OWP/inundation-mapping) and forecasts from the [National Water Model](https://water.noaa.gov/about/nwm) or the AWI water model. Check out the [Hydro-intel scorecards](https://hydro-intel.lynker-spatial.com/) or see the [quickstart](/data-service/accessing-data.md) for more details.
13+
A **FIM library** denotes a specific database. These databases are composed of and partitioned into individual units referred to as **volumes**. FloodFabric harmonizes these varied volumes into distinguishable flood library access patterns, which are selectable via the menu on the left side of the dashboard. Currently,you can select the [National Water Model HAND libraries](https://github.com/NOAA-OWP/inundation-mapping) and forecasts from the [National Water Model](https://water.noaa.gov/about/nwm) or the AWI water model. You can also look at historic events, or flood predictions based on the NWM Hindcast. Check out the [Hydro-intel scorecards](https://hydro-intel.lynker-spatial.com/) or see the [quickstart](/data-service/accessing-data.md) for more details.
1214

1315
### Library access patterns:
1416

15-
You can access a FIM library in a number of ways. FloodFabric exposes discharge based access patterns leaning on the [FlowFabric API](https://flowfabric-api.lynker-spatial.com/) and model outputs. What to see FloodFabric implemented spesifically for yuor area? Please [reach out](https://lynker-spatial.com/#contact)!
17+
You can access a FIM library in a number of ways. FloodFabric exposes discharge-based access patterns leaning on the [FlowFabric API](https://flowfabric-api.lynker-spatial.com/) and model outputs. Want to see FloodFabric implemented specifically for your area? Please [reach out](https://lynker-spatial.com/#contact)!

docs/data-service/gridded.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,4 +187,4 @@ execute_zonal(geom = colorado, fun = "mean", ID = "fips_code")
187187

188188
## The Tiles marketplace
189189

190-
The [tiles marketplace quickstart](/data-service/tiles.md) provides more information on how to access to geospatial tile data useful for watershed analysis, flood mapping, land cover classification, and more. For even more information on how you can use these tiles within your development workflows, see the [marketplace quickstart](https://tiles.lynker-spatial.com/docs/index.html#getting-started) for more detailed information on how to use that data within your favored application, be it a GUI driven GIS envrionement such as ArcGIS or QGIS, code environements such as R and Python, or any of the most propular web mapping platforms like MapLibre or Leaflet.
190+
The [tiles marketplace quickstart](/data-service/tiles.md) provides more information on how to access to geospatial tile data useful for watershed analysis, flood mapping, land cover classification, and more. For even more information on how you can use these tiles within your development workflows, see the [marketplace quickstart](https://tiles.lynker-spatial.com/docs/index.html#getting-started) for more detailed information on how to use that data within your favored application, be it a GUI driven GIS environment such as ArcGIS or QGIS, code environments such as R and Python, or any of the most popular web mapping platforms like MapLibre or Leaflet.

docs/data-service/hydrofabric.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
[![](/img/hydrofabric_hero.png)](https://hydrofabric.lynker-spatial.com/)
44

5-
The [Lynker Spatial Hydrofabric](https://hydrofabric.lynker-spatial.com/) represents a modern, cloud-native approach to next-generation water resource modeling. Built in close collaboration between NOAA, the USGS, and Lynker, these modular artifacts provide a unified hydrologic framework. They are designed to be easily updated, manipulated, and quality-controlled to meet the needs of a wide range of modeling tasks while leveraging the best possible authoritative input data.
5+
The [Lynker Spatial Hydrofabric](https://hydrofabric.lynker-spatial.com/) is a modern, cloud-native framework for next-generation water resource modeling. Developed in close collaboration with NOAA and the USGS, these modular artifacts provide a unified hydrologic system designed for efficient updates, manipulation, and quality control. This framework enables a wide range of modeling tasks while leveraging authoritative input data.
66

7-
## Cloud Native Data Archives
7+
## Cloud-Native Data Archives
88
NextGen hydrofabric artifacts are publicly available through the Lynker Spatial Data Service. By centralizing these datasets in cloud-native formats, users can interact with massive hydrologic networks without downloading the entire national database.
99

1010
## Installation and Setup
@@ -18,7 +18,7 @@ remotes::install_github("NOAA-OWP/hydrofabric")
1818
library(hydrofabric)
1919
```
2020

21-
Loading library(hydrofabric) will attach core modular packages, including:
21+
Loading `library(hydrofabric)` will attach core modular packages, including:
2222

2323
* **hfsubsetR**: For cloud-based hydrofabric subsetting.
2424
* **hydrofab**: A toolset for "fabricating" multiscale hydrofabrics.

docs/data-service/tiles.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,21 @@
22

33
[![](/img/tiles_hero.png)](https://tiles.lynker-spatial.com/)
44

5-
The [Lynker Spatial Tile marketplace](https://tiles.lynker-spatial.com/) provides cloud-hosted vector and raster tile datasets (such as the Modeling Hydrofabric, Continental Rivers, and National Wetlands]) optimized for web and desktop applications. All data is served in Protocol Buffer (PBF) format and requires JWT Bearer token authentication. This guide will help you quickly set up your account, authenticate, and pull your first tile from the Lynker Spatial Tile Service! For more details see the [more extensive tiles documentation](https://tiles.lynker-spatial.com/docs/index.html#getting-started).
5+
The [Lynker Spatial Tile marketplace](https://tiles.lynker-spatial.com/) provides cloud-hosted vector and raster tile datasets (such as the Modeling Hydrofabric, Continental Rivers, and National Wetlands) optimized for web and desktop applications. All data is served in Protocol Buffer (PBF) format and requires JWT Bearer token authentication. This quickstart guide will help you quickly set up your account, authenticate, and pull your first tile from the Lynker Spatial Tile Service! For more details see the [more extensive tiles documentation](https://tiles.lynker-spatial.com/docs/index.html#getting-started).
66

77
### Step 1: Log into your Lynker Spatial data proxy Account
88
1. Visit the [Lynker Spatial Authentication Portal](https://proxy.lynker-spatial.com/) (see the [Authentication quickstart](https://docs.lynker-spatial.com/data-service/authentication) for more details) to sign in.
99

1010
### Step 2: Get Your Access Token
11+
1112
Access to the Map Tiles requires a JWT Bearer token. Tokens are user-specific and expire after 1 day (Refresh tokens last 30 days).
1213

1314
You can retrieve your token programmatically using Python (`boto3`), or you can copy it directly from your active session in the authentication portal.
1415

1516
:::::tabs
1617
== GUI session
1718

18-
Navigate to: https://proxy.lynker-spatial.com/token to find the relevent token you'll need.
19+
Navigate to: https://proxy.lynker-spatial.com/token to find the relevant token you'll need.
1920

2021
[![](/img/gui_token.png)](https://proxy.lynker-spatial.com/token)
2122

@@ -48,7 +49,8 @@ print(TOKEN)
4849

4950

5051
### Step 3: Verify Service Access
51-
Once you have your token, export it to your environment and verify the connection by calling the catalog endpoint. An easy way to test this is in the command line:
52+
53+
Once you have your token, export it to your environment and verify the connection by calling the catalog endpoint. An easy way to test this is in the command-line:
5254

5355
:::::tabs
5456
== Windows cmd
@@ -59,7 +61,7 @@ set "LYNKER_TOKEN=<your_token_here>"
5961
curl -H "Authorization: Bearer %LYNKER_TOKEN%" https://tiles.lynker-spatial.com/catalog
6062
```
6163

62-
If you've done this correctly it should print out a list of the avalible tiles like so:
64+
If you've done this correctly it should print out a list of the available tiles like so:
6365

6466
![](/img/windows_success_auth.png)
6567

@@ -88,16 +90,21 @@ To use the tiles within a QGIS session:
8890
2) Click the New button to create a new connection
8991
3) Enter connection details:
9092

93+
```md
9194
Name: Lynker Hydrofabric
92-
URL: https://tiles.lynker-spatial.com/api/tiles/lynker-spatial-modeling-fabric/{z}/{x}/{y} (omit .pbf extension)
95+
URL: https://tiles.lynker-spatial.com/api/tiles/lynker-spatial-modeling-fabric/{z}/{x}/{y}
96+
```
9397

9498
4) Go to the HTTP Headers tab and add custom header:
99+
100+
```md
95101
Header Name: Authorization
96102
Header Value: Bearer <your_token_here>
103+
```
97104

98105
5) Click OK and save the connection
99106
6) Select the connection from the list and add the layer
100-
7) gure symbology by right-clicking the layer → Properties → Symbology
107+
7) Configure symbology by right-clicking the layer → Properties → Symbology
101108

102109

103110
== MapLibre GL JS
@@ -126,4 +133,4 @@ map.addLayer({
126133

127134
:::::
128135

129-
Find more information on how to use the Lynker Spatial gridded data packages at it's [quickstart here](/data-service/gridded.md), or see how you can apply the [flowfabric-api](https://flowfabric-api.lynker-spatial.com/) to gain [Hydro-intellegence](/data-service/accessing-data.md) on their assoisated quickstarts.
136+
Find more information on how to use the Lynker Spatial gridded data packages at its [quickstart here](/data-service/gridded.md), or see how you can apply the [flowfabric-api](https://flowfabric-api.lynker-spatial.com/) to gain [Hydro-intelligence](/data-service/accessing-data.md) on their associated quickstarts.

docs/index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ import Card from "@/components/Card.vue";
2323
<img src="/assets/img/logo-dark.svg" class="logo-dark-mode" style="width: 100vw;" alt="Lynker Spatial Logo" />
2424
</a>
2525

26-
> These docs covers the principal utilities and offerings of the [lynker spatial](https://lynker-spatial.com/#top). These are all in very active development so check back often to see what's new!
27-
2826
<style>
2927
/* Default to light mode: hide the logo meant for dark mode */
3028
html:not(.dark) .logo-dark-mode {
@@ -37,26 +35,28 @@ html.dark .logo-light-mode {
3735
}
3836
</style>
3937

40-
> These docs covers the principal utilities and offerings of the [lynker spatial](https://lynker-spatial.com/#top). These are all in very active development so check back often to see what's new!
38+
> This documentation covers the principal utilities and offerings of [Lynker Spatial](https://lynker-spatial.com/#top). These resources are under active development; please check back often to see what's new!
4139
4240
## For the Public
4341

44-
The core objective of the Lynker Spatial team is to help you build a better decision. Wheather it's for flood forecasting, water intelligence, or geospatial asset managment, if you need to make an informed decision built on real-time data, the Lynker spatial offerings are here to facilitate that. If you are just exploring or need a quick helper to better anticipate the risks you face, there are several open and acessable landing pages built spesifically for your needs. These include:
42+
The core mission of the Lynker Spatial team is to help you make better-informed decisions. Whether you are focused on flood forecasting, water intelligence, or geospatial asset management, our offerings provide the real-time data necessary to anticipate risk.
43+
44+
If you are exploring our capabilities or need immediate insights, we provide several open-access landing pages tailored to specific needs:
4545

46-
* The [Hydrofabric Viewer](https://hydrofabric.lynker-spatial.com/), which will help you better place your location in context with the National Water Forecasting enterprise
47-
* The [Hydro-Intelligence Scorecards](https://hydro-intel.lynker-spatial.com/), which helps you find the model and forecast that is right for you.
48-
* The [FloodFabric Dashboard](https://floodfabric.lynker-spatial.com/), which places the flood prediction front and center and helps remove the guesswork assosiated with determining wheater your building or roadway are in danger of inundationg.
46+
* **[Hydrofabric Viewer](https://hydrofabric.lynker-spatial.com/):** Contextualize your location within the broader National Water Forecasting enterprise.
47+
* **[Hydro-Intelligence Scorecards](https://hydro-intel.lynker-spatial.com/):** Evaluate and select the models and forecasts that best suit your requirements.
48+
* **[FloodFabric Dashboard](https://floodfabric.lynker-spatial.com/):** Access front-and-center flood predictions to remove the guesswork when determining if infrastructure, such as buildings or roadways, is at risk of inundation.
4949

50-
All of these tools are free, open, graphical, and interactive, allowing you to quickly build a more informed strategy specific to your level of risk tolerance. If these applications spark inspiration or if you want a customized solution tailored specifically for your use cases, we are here to help. Please, [reach out to the Lynker Spatial team](https://lynker-spatial.com/#contact) to see what we can build with you together!
50+
These tools are free, open-source, and interactive, allowing you to build a strategy tailored to your specific risk tolerance. If these applications spark a new idea or if you require a custom solution, please [reach out to the Lynker Spatial team](https://lynker-spatial.com/#contact) to see what we can build together with you.
5151

5252
## For Power Users and Developers
5353

54-
The Lynker spatial platform is built to enable a common starting point off which you can build your own applications and create your own applications, extending on our data and platforms. The Data Platform provides authenticated access to the vast datastores that power the intellegence Lynker Spatial provides.
54+
The Lynker Spatial platform provides a foundational ecosystem for building and extending your own applications. By leveraging our data and infrastructure, developers can integrate high-level intelligence into their own workflows.
5555

56-
* Use the [FlowFabric API and Packages](https://flowfabric-api.lynker-spatial.com/), to faciltate seamless access to those data using programatic patterns.
57-
* Use the [geospatial tile marketplace](https://tiles.lynker-spatial.com/) for access to useful and usable geospataial datasets.
56+
* **[FlowFabric API and Packages](https://flowfabric-api.lynker-spatial.com/):** Access our core data seamlessly using programmatic patterns and dedicated libraries.
57+
* **[Geospatial Tile Marketplace](https://tiles.lynker-spatial.com/):** Connect to high-performance, ready-to-use geospatial datasets.
5858

59-
[Reach out to the team](https://lynker-spatial.com/#contact) if you have data, use cases, or applications you'd like to see implemented!
59+
If you have specific data needs, use cases, or applications you would like to see implemented, [reach out to the team](https://lynker-spatial.com/#contact) to discuss collaboration.
6060

6161
<Home>
6262

0 commit comments

Comments
 (0)