Blazing fast JavaScript Raster Processing Engine
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
data fixed mapspam data issue Jan 6, 2019
docs
src
.babelrc
.eslintrc.json
.gitignore
.npmignore
.travis.yml
LICENSE
README.md Added logo to Readme Aug 7, 2018
documentation.yml
index.js
package-lock.json updated eslint-loader dep to fix build bug and added webpack-cli Jan 11, 2019
package.json
setup.sh
test-app.js added eslint May 11, 2018
webpack.analyze.js
webpack.base.js
webpack.dev.js updated build for version 0.1.1 May 11, 2018
webpack.prod.js

README.md

Maintainability Test Coverage

Geoblaze

A blazing fast javascript raster processing engine


Geoblaze is a geospatial raster processing engine written purely in javascript. Powered by geotiffjs, it provides tools to analyze GeoTIFFs. Using geoblaze, you can run computations ranging from basic statistics (min, max, mean, mode) to band arithmetic and histogram generation in either a web browser or a node application.

Learn more by reading our documentation

Getting Started

  1. Add Geoblaze to your project
  npm install geoblaze
  1. Load a GeoTIFF and run a calculation
import geoblaze from 'geoblaze';

const url = 'http://url-to-geotiff';

async function getMean () {
  const raster = await geoblaze.load(url);
  return geoblaze.mean(raster);
}

This is a contrived example, but using geoblaze is really this simple!

Contributing

We would love to have your support improving geoblaze. Here are some ways to contribute:

Issues

If you find a 🐛, please report it as an issue! To avoid overwhelming our developers, please first scan the list of bugs to make sure it hasn't already been reported. Make sure to add steps to reproduce, so we can quickly find and fix the problem.

We are also accepting feature requests! Our goal is to make geoblaze as useful to the community as possible. Towards that goal, we would love suggestions for additional features to improve the tool.

Please tag issues with the appropriate label.

Pull Requests

We are always accepting new PRs. To get started, see the developer's guide below

We squash and rebase all PRs. Please squash all of your commits into one and rebase off dev.

Submitting a PR

  1. Make sure the branch is rebased and passing tests.

  2. Answer all of the questions in the PR template.

  3. Add the "needs review" label to your PR.

  4. Upon review, the label will be adjusted. If the label is switched to "needs development", this means there are comments that need to be addressed. After addressing the comments, move the label back to "needs review"

  5. Once comments have been addressed, a reviewer will move the label to "can deploy". After a final check, the PR will be merged and deployed.

Developer's Guide

Setup

  1. Fork the repository

  2. Clone your fork

  git clone git@github.com:[your-username]/geoblaze.git
  1. Install dependencies
  cd geoblaze
  npm install

Linting

Geoblaze uses eslint for linting. We suggest using an eslint plugin for your text editor. Here are some common options:

Our style guide extends the eslint:recommended set of standards and is therefore relatively minimal. As the project expands in scope and number of contributors, we will start to consider more linting rules. Please feel free to suggest some in a PR!

To test for linting errors:

  npm run lint

Testing

Geoblaze uses mocha as its testing framework. To learn more, see their getting started guide.

To run tests:

  1. Run the setup script. This script will download all of the necessary test data from s3.
  npm run setup
  1. Spin up the test node server
  npm run server
  1. In a separate tab, run tests
  npm run test