Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FlowmapBlue proposal to join vis.gl #7

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 158 additions & 0 deletions proposals/flowmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
# FlowmapBlue and flowmap.gl

This is a proposal to transfer FlowmapBlue and flowmap.gl to vis.gl, a OpenJS Foundation project within the Open Visuaization Collaboration Space (formerly the Urban Computing Foundation).

> Note: This proposal was originally accepted by the vis.gl Technical Steering Committee (TSC) on 2022-06-07 when the Urban Computing Foundation merged into the OpenJS Foundation.

## Project description

FlowmapBlue is a tool for representing numbers of movements between geographic locations. It is used by people around the globe to visualize urban mobility, commuting behavior, bus, subway and air travels, bicycle sharing, human and bird migration, refugee flows, freight transportation, marine traffic, trade and many other topics.

Flowmap.gl is a JavaScript library for flow map rendering. It's meant for use with deck.gl as an extension layer. The layer is rendered in WebGL and can handle relatively large numbers of flows with a good rendering performance.

FlowmapBlue is using flowmap.gl and deck.gl for rendering. Together, FlowmapBlue and flowmap.gl form a coherent package.


## Statement on alignment with OpenJS Foundation charter's mission

Flow maps are a useful tool for the analysis of urban mobility. Understanding how people move in cities is important for improving urban safety, road infrastructure, traffic congestion, resource utilization and energy consumption.

FlowmapBlue is used by GIS analysts, transport and urban planners, mobility service providers and researchers for visualizing urban mobility data coming from various sources: census, surveys, simulation models, service usage statistics, sensors (e.g. mobile phones).

FlowmapBlue focuses on the ease of use and the readability of the visualization. The tool employs adaptive clustering, filtering and summarization and offers a unique scalable approach for representing geographic movement at varying aggregation levels. The goal of the tool is to make flow mapping truly scalable and easy to use for as many people as possible.


## Link to current Code of Conduct

- [FlowmapBlue](https://github.com/FlowmapBlue/FlowmapBlue/blob/master/CODE_OF_CONDUCT.md)


## Sponsor from TSC

Ib Green


## Project license

- `FlowmapBlue` - Apache 2.0 license
- `flowmap.gl` - MIT license


## Source control

All projects are on GitHub:

- [FlowmapBlue](https://github.com/FlowmapBlue/FlowmapBlue)
- [flowmap.gl](https://github.com/FlowmapBlue/flowmap.gl)


## Issue tracker

All issues are currently managed on GitHub:

- [FlowmapBlue](https://github.com/FlowmapBlue/FlowmapBlue/issues)
- [flowmap.gl](https://github.com/FlowmapBlue/flowmap.gl/issues)


## External dependencies

FlowmapBlue:

- `@mapbox/geo-viewport` - BSD-2-Clause
- `@sentry/browser` - BSD-3-Clause
- `blueimp-md5` - MIT
- `blueprintjs` - Apache-2.0
- `d3` - BSD-3-Clause
- `deck.gl` - MIT
- `emotion` - MIT
- `flowmap.gl` - Apache-2.0
- `kdbush` - ISC
- `luma.gl` - MIT
- `math.gl` - MIT
- `mjolnir.js` - MIT
- `query-string` - MIT
- `react` - MIT
- `react-fetch-hook` - MIT
- `react-helmet` - MIT
- `react-map-gl` - MIT
- `react-map-gl-draw` - MIT
- `react-player` - MIT
- `react-popper` - MIT
- `react-refetch` - MIT
- `react-router` - MIT
- `react-use` - Unlicense
- `recompose` - MIT
- `seedrandom` - MIT
- `turf` - MIT



flowmap.gl:

- `@mapbox/geo-viewport` - BSD-2-Clause
- `d3` - BSD-3-Clause
- `kdbush` - ISC
- `reselect` - MIT



## Release methodology and mechanics


#### flowmap.gl

We use semantic versioning. For a new release a new branch is created into which pull requests are merged. Then, it's merged into master a the release is published.


#### FlowmapBlue

No release system at the moment. Changes and improvements are published to the website once a PR is merged to master.


## Names of initial committers, if different from those submitting proposal

- Ilya Boyandin (Teralytics)
- Fabio Berta (Teralytics)


## Briefly describe the project's leadership team and decision-making process

Both projects are led and developed predominantly by Ilya Boyandin.
There have been a few external contributions to flowmap.gl.

If the projects are accepted into vis.gl, we hope that it would help grow the community and attract external contributiors.


## Link to any documented governance practices

None at the moment.

## Preferred maturity level

Growth stage


## List of project's official communication channels

- FlowmapBlue: [Spectrum Chat](https://spectrum.chat/flowmap-blue/), [Newsletter](https://tinyletter.com/flowmap-blue/archive)

## Link to project's website

- [FlowmapBlue](https://flowmap.blue/)
- [flowmap.gl](https://flowmapblue.github.io/flowmap.gl/)

## Links to social media accounts

None

## Existing financial sponsorship

- Teralytics backs the development of flowmap.gl
- Mapbox provides a discount coupon for the background map
- Netlify provides an [Open Source plan](https://www.netlify.com/legal/open-source-policy/) for the FlowmapBlue website


## Infrastructure needs or requests

- Domain registration
+ flowmap.gl