Data

Tools

Indexes

Applications

Experiments

Open Source Science

leaflet-velocity

Visualise velocity data on a leaflet layer

https://github.com/onaci/leaflet-velocity

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ✓
    Institutional organization owner
    Organization onaci has institutional domain (www.csiro.au)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.9%) to scientific vocabulary

Keywords

current leaflet ocean velocity visualisation visualization water weather wind

Keywords from Contributors

interactive mesh interpretability sequences generic projection optim hacking network-simulation
Last synced: 6 months ago · JSON representation ·

Repository

Visualise velocity data on a leaflet layer

Basic Info
Statistics
  • Stars: 642
  • Watchers: 26
  • Forks: 221
  • Open Issues: 26
  • Releases: 18
Topics
current leaflet ocean velocity visualisation visualization water weather wind
Created about 9 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Citation

README.md

leaflet-velocity NPM version NPM Downloads

Version 2 Notice

As of version 2, leaflet-velocity is now under CSIRO's Open Source Software Licence Agreement, which is variation of the BSD / MIT License.

There are no other plans for changes to licensing, and the project will remain open source.

A plugin for Leaflet (v1.0.3, and v0.7.7) to create a canvas visualisation layer for direction and intensity of arbitrary velocities (e.g. wind, ocean current).

Live Demo: https://onaci.github.io/leaflet-velocity/

  • Uses a modified version of WindJS for core functionality.
  • Similar to wind-js-leaflet, however much more versatile (provides a generic leaflet layer, and not restricted to wind).
  • Data input format is the same as output by wind-js-server, using grib2json.

Screenshot

Example use:

```javascript var velocityLayer = L.velocityLayer({ displayValues: true, displayOptions: { // label prefix velocityType: "Global Wind",

// leaflet control position
position: "bottomleft",

// no data at cursor
emptyString: "No velocity data",

// see explanation below
angleConvention: "bearingCW",

// display cardinal direction alongside degrees
showCardinal: false,

// one of: ['ms', 'k/h', 'mph', 'kt']
speedUnit: "ms",

// direction label prefix
directionString: "Direction",

// speed label prefix
speedString: "Speed",

}, data: data, // see demo/*.json, or wind-js-server for example data service

// OPTIONAL minVelocity: 0, // used to align color scale maxVelocity: 10, // used to align color scale velocityScale: 0.005, // modifier for particle animations, arbitrarily defaults to 0.005 colorScale: [], // define your own array of hex/rgb colors onAdd: null, // callback function onRemove: null, // callback function opacity: 0.97, // layer opacity, default 0.97

// optional pane to add the layer, will be created if doesn't exist // leaflet v1+ only (falls back to overlayPane for < v1) paneName: "overlayPane", }); ```

The angle convention option refers to the convention used to express the wind direction as an angle from north direction in the control. It can be any combination of bearing (angle toward which the flow goes) or meteo (angle from which the flow comes), and CW (angle value increases clock-wise) or CCW (angle value increases counter clock-wise). If not given defaults to bearingCCW.

The speed unit option refers to the unit used to express the wind speed in the control. It can be m/s for meter per second, k/h for kilometer per hour or kt for knots. If not given defaults to m/s.

Public methods

| method | params | description | | ------------ | ---------- | --------------------------------- | | setData | {Object} | update the layer with new data | | setOptions | {Object} | update the layer with new options |

Build / watch

shell npm run watch

Reference

leaflet-velocity is possible because of things like:

Example data

Data shown for the Great Barrier Reef has been derived from CSIRO's eReefs products

License

CSIRO Open Source Software Licence Agreement (variation of the BSD / MIT License)

Owner

  • Name: CSIRO Oceans and Atmosphere - Coastal Informatics Team
  • Login: onaci
  • Kind: organization
  • Location: Australia

Citation (CITATION.cff) 

cff-version: 1.2.0
title: Leaflet Velocity
version: 2.1.2
message: 'If you use this software, please cite it as below.'
type: software
url: "https://github.com/onaci/leaflet-velocity"
authors:
  - given-names: Daniel Wild
    family-names: Wild
    email: mail@danwild.io
    affiliation: >-
      Commonwealth Scientific and Industrial Research
      Organisation (CSIRO)
    orcid: 'https://orcid.org/0000-0002-5127-2327'

GitHub Events

Total
  • Issues event: 3
  • Watch event: 44
  • Issue comment event: 6
  • Fork event: 10
Last Year
  • Issues event: 3
  • Watch event: 44
  • Issue comment event: 6
  • Fork event: 10

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 108
  • Total Committers: 10
  • Avg Commits per committer: 10.8
  • Development Distribution Score (DDS): 0.343
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Dan Wild d****d@y****m 71
dependabot[bot] 4****] 18
Luc Claustres l****s@o****r 5
brentfraser b****r@g****m 3
Gustavo Porto g****o@q****m 2
Olegas Goncarovas o****n@s****m 2
Myles McManus m****c@g****m 2
Phil Krull p****l@f****m 2
Seth Lutske 5****2 2
Pierre Vernier p****2@g****m 1
Committer Domains (Top 20 + Academic)
fivepackcreative.com: 1 stormgeo.com: 1 quanticosolutions.com: 1 geoanalytic.com: 1 orange.fr: 1 y7mail.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 69
  • Total pull requests: 36
  • Average time to close issues: 5 months
  • Average time to close pull requests: 29 days
  • Total issue authors: 59
  • Total pull request authors: 11
  • Average comments per issue: 2.22
  • Average comments per pull request: 0.25
  • Merged pull requests: 30
  • Bot issues: 0
  • Bot pull requests: 21
Past Year
  • Issues: 3
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 3
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • claustres (3)
  • tkrueger73 (3)
  • SFSailor (2)
  • AugustinMortier (2)
  • kt7456 (2)
  • leoGrg (2)
  • xelaboy (2)
  • maihannijat (2)
  • chakravarthi-vl (1)
  • crazyfrog30 (1)
  • ghybs (1)
  • cookmaster (1)
  • saltynexus (1)
  • dceejay (1)
  • harksin (1)
Pull Request Authors
  • dependabot[bot] (20)
  • claustres (4)
  • ogix (2)
  • brentfraser (2)
  • slutske22 (1)
  • MikeScheurwater (1)
  • hotfudgecake (1)
  • phil-krull (1)
  • mylesmc123 (1)
  • pvernier (1)
  • portothree (1)
Top Labels
Issue Labels
enhancement (1) help wanted (1) question (1)
Pull Request Labels
dependencies (20)

Packages

  • Total packages: 2
  • Total downloads:
    • npm 8,299 last-month
  • Total docker downloads: 767
  • Total dependent packages: 9
    (may contain duplicates)
  • Total dependent repositories: 58
    (may contain duplicates)
  • Total versions: 56
  • Total maintainers: 1
npmjs.org: leaflet-velocity

A custom layer for leaflet to visualise arbitrary velocities

  • Versions: 38
  • Dependent Packages: 9
  • Dependent Repositories: 58
  • Downloads: 8,299 Last month
  • Docker Downloads: 767
Rankings
Docker downloads count: 1.0%
Downloads: 1.2%
Dependent repos count: 1.8%
Average: 2.0%
Dependent packages count: 2.2%
Forks count: 2.4%
Stargazers count: 3.1%
Maintainers (1)
danwild
Last synced: 6 months ago
proxy.golang.org: github.com/onaci/leaflet-velocity
  • Versions: 18
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago

Dependencies

package-lock.json npm
  • 691 dependencies
package.json npm
  • @babel/core ^7.5.4 development
  • @babel/preset-env ^7.5.4 development
  • babel-preset-es2015 ^6.9.0 development
  • cssnano ^4.1.10 development
  • gulp ^4.0.2 development
  • gulp-babel ^8.0.0 development
  • gulp-concat ^2.6.1 development
  • gulp-concat-css ^3.1.0 development
  • gulp-postcss ^8.0.0 development
  • gulp-rename ^1.4.0 development
  • gulp-uglify ^3.0.2 development