locationtech / locationtech/geotrellis

Add How To Use Rasters section to new mdocs

Open
#3,306 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Scala
Stars
1.4k
Forks
360
Avg merge
6h 57m
Merged PRs (30d)
12

Description

Add a Raster section that provides brief how-tos for each of these topics:

  • Terminology including CellType/CellSize/NoData, Tile, Raster definitions in GT context
  • Rendering: ColorMap, ColorRamp, Color Correction
  • Histograms
  • Polygonal Summary

These topics are currently addressed in https://github.com/geotrellis/geotrellis-workshop/blob/master/docs/rendering-images.md, https://github.com/geotrellis/geotrellis-workshop/blob/master/docs/histograms.md.

Also, ensure we instruct users to either run the the raster tests via SBT once or unzip the raster tests package if we end up using any of the test rasters in our examples ( see #3178 )

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing GeoTrellis Workshop sources in docs/rendering-images.md and docs/histograms.md, then review the requested terminology, rendering, histogram, and polygonal summary topics. Add the corresponding Raster section to the new mdocs and document whether users should run the raster tests through SBT or unzip the raster tests package when examples use test rasters, as noted in #3178.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.