WeatherLayers GL

repository·main·Indexed 41 days ago

https://github.com/weatherlayers/weatherlayers-gl

A library providing specialized weather visualization layers and controls specifically built for integration with deck.gl. Version 2026.9.0-alpha.1 includes a Client API for managing STAC catalogs, loading weather datasets, and configuring specialized layers such as contour, grid, high-low, and particle layers.

Tokens
5.2K
Snippets
17
Records
31
Agent score
47%

What's inside WeatherLayers GL

  1. Data Authorization Requirements

    main

    When using the Library to visualize data (including self-hosted data), the User is responsible for ensuring they have sufficient legal authorization to use that data.

    Key obligations:

    • You must obtain all necessary consents, licenses, or authorizations if the data is sourced from a third party.
    • You must be able to provide written evidence of these authorizations to the Provider within 7 days of a written request.
    • Failure to comply can lead to suspension of the License and Services, and may incur a contractual penalty of EUR 4,000 per violation.
  2. Usage Restrictions and Prohibitions

    main

    The License grants a non-exclusive right to use the Library and Technical Documentation for internal purposes. Users are prohibited from the following:

    • Reverse Engineering: You may not disrupt or circumvent minification, decompile, disassemble, or attempt to obtain the source code of the Library.
    • Distribution: You may not distribute, lend, rent, or communicate the Library or Documentation to third persons (including providing access to Library functionalities online).
    • Modification: You may not modify or adapt the Library or Documentation, or create derivative works (though integration with the Web Application via API is permitted).
    • Redistribution of Notices: You may not remove the Provider's copyright notices.
    • Security Interference: You may not interfere with security measures or insert harmful code (malware, viruses, etc.).
  3. Understand the different WeatherLayers GL License types

    main

    The Library is available under several license types, each with different scopes and restrictions:

    • Trial License: An unpaid license for a 30-day term, intended for testing the Library's functionalities. All other provisions of the Single Domain License apply.
    • Single Domain License: A paid license for use in a single User Application hosted under a single production domain name. You may use additional development domain names (for employees/contractors), but these must be notified to the Provider. If you need to use the Library for more User Applications, you must purchase an additional Single Domain License for each.
    • Multiple Domain License (OEM): A paid license for use in a single User Application hosted under an unlimited number of domain names. Domain names do not need to be notified to the Provider.
    • Non-Commercial Version: A license for non-profit User Applications. To qualify, the application must be free of charge, contain no paid advertisements, offer no in-app purchases, include no paid functions, and be available to the wide public (e.g., via App Store or Google Play).
  4. Support and Maintenance Services

    main

    The purchase of a paid License includes 1 year of Services (support and maintenance) starting from the date the License is provided.

    Service Details:

    • Scope: Support for failures, faults, or problems in the Library or Technical Documentation. You can contact the Provider via mailto:support@weatherlayers.com.
    • Resolution: The Provider provides advice or work-around solutions but does not guarantee specific response or resolution times.
    • Continuity: To ensure continued support after the initial 1-year term, a separate support and maintenance agreement must be concluded before the current term expires.
  5. Expand ESLint configuration for type-aware linting

    main

    When developing a production application, it is recommended to enable type-aware lint rules in your ESLint configuration. This involves updating parserOptions to point to your tsconfig files and switching to type-checked plugin recommendations.

    Steps to update configuration:

    1. Configure parserOptions with ecmaVersion, sourceType, project (pointing to your tsconfig files), and tsconfigRootDir.
    2. Replace plugin:@typescript-eslint/recommended with plugin:@typescript-eslint/recommended-type-checked or plugin:@typescript-eslint/strict-type-checked.
    3. (Optional) Add plugin:@typescript-eslint/stylistic-type-checked.
    4. Install eslint-plugin-react and add plugin:react/recommended and plugin:react/jsx-runtime to the extends list.
    export default {
      // other rules...
      parserOptions: {
        ecmaVersion: 'latest',
        sourceType: 'module',
        project: ['./tsconfig.json', './tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: __dirname,
      },
    }
  6. Obtain the WeatherLayers GL Library

    main

    To use the Library, you must first purchase a License. You can do this by concluding a contract via email or through a user account in the WeatherLayers Web Application.

    Steps to obtain the Library:

    1. Sign up: Create a free account at https://weatherlayers.com (using the "Sign up" button) or at https://account.weatherlayers.com.
    2. Select License: Choose your desired license type and provide the required information.
    3. Payment: Complete the purchase. The contract is officially concluded once the price is fully paid and the Provider confirms the order via email.
    4. Delivery: The Provider will deliver the Library via email or provide a download link (with credentials if necessary) within 10 days of purchase confirmation.
  7. Understand STAC Collection extensions for WeatherLayers

    main

    The StacCollection interface supports standard STAC properties, but also includes specific extensions used by the WeatherLayers Cloud Client to configure how weather data is rendered and controlled.

    When implementing or consuming a STAC Collection, you can include these custom keys in the object:

    • weatherLayers:imageType: Defines the type of image data.
    • weatherLayers:imageUnscale: An array [number, number] or null used to unscale raster values.
    • weatherLayers:units: An array of UnitDefinition objects.
    • weatherLayers:layers: A DatasetLayersConfig object for layer management.
    • weatherLayers:controls: A DatasetControlsConfig object for dataset controls.
  8. Configure weather dataset layers with DatasetLayersConfig

    main

    The DatasetLayersConfig interface is used to configure different types of weather dataset layers. You can optionally specify configurations for contourLayer, gridLayer, highLowLayer, and particleLayer. Each layer type has its own specific configuration requirements.

    const config: DatasetLayersConfig = {
      contourLayer: {
        interval: 1,
        majorInterval: 5
      },
      gridLayer: {
        style: myGridStyle,
        iconBounds: [-10, -10, 10, 10]
      },
      highLowLayer: {
        radius: 50
      },
      particleLayer: {
        speedFactor: 1.5,
        width: 2
      }
    };
  9. Access the WeatherLayers GL client API

    main
    The src/client/index.ts file serves as the primary entrypoint for the WeatherLayers GL client module. It re-exports all functionality from ./client.js and utility functions from ./_utils.js. To use the client, import from the main client entrypoint to access core classes and methods for managing weather layers.