InteractiveTutorials
Under DevelopmentFollow these guided walk-throughs to learn how to query, manipulate, and analyze environmental and remote sensing assets on our computational clusters.
Planetary Data Walkthrough
The following tutorial demonstrates the basic developer workflow for authenticating with the API platform, searching through satellite archives, and running raster mathematical matrices.
Authentication & Setup
Secure an API access token from the dashboard and establish a secure connection using the SDK client configurations.
| 1 | // Import the official VELSTROM Client SDK |
| 2 | import { VelstromClient } from "@velstrom/sdk-js"; |
| 3 | |
| 4 | // Initialize with your private early-access API credential key |
| 5 | const client = new VelstromClient({ |
| 6 | apiKey: "vel_live_8f39b1a0e8354c00a421", |
| 7 | }); |
Query Satellite Imagery Metadata
Define a region of interest (Bounding Box coords) and retrieve available multispectral imagery catalogs from Sentinel-2.
| 1 | // Define bounding coordinates [Min Longitude, Min Latitude, Max Longitude, Max Latitude] |
| 2 | const bbox = [-122.68, 45.51, -122.65, 45.53]; |
| 3 | |
| 4 | const imageryMetadata = await client.imagery.search({ |
| 5 | bbox: bbox, |
| 6 | platform: "sentinel-2", |
| 7 | cloudCoverLimit: 0.15, // Retrieve files with less than 15% cloud cover |
| 8 | timeframe: { |
| 9 | start: "2026-05-01", |
| 10 | end: "2026-06-01", |
| 11 | } |
| 12 | }); |
| 13 | |
| 14 | console.log(`Found ${imageryMetadata.items.length} imagery items.`); |
Compute Custom Environmental Index
Pass raw sensor bands (Near Infrared and Red) to calculate indices on the compute nodes, returning geo-referenced matrix assets.
| 1 | // Execute on-the-fly NDVI matrix math directly on VELSTROM clusters |
| 2 | const ndviMap = await client.imagery.computeIndex({ |
| 3 | itemId: imageryMetadata.items[0].id, |
| 4 | index: "NDVI", |
| 5 | options: { |
| 6 | resolution: "10m", |
| 7 | format: "GeoTIFF" |
| 8 | } |
| 9 | }); |
| 10 | |
| 11 | console.log("NDVI computed successfully. Status:", ndviMap.status); |
Ready for more execution?
Launch a Google Colab instance to run live Python notebooks in the cloud.