sbrl-github/terrain50-cli
1
0
Fork 0
mirror of https://github.com/sbrl/terrain50-cli.git synced 2024-10-31 03:43:01 +00:00
Code Issues Releases Wiki Activity
terrain50-cli/README.md
Starbeamrainbowlabs 6ec176d895
image: Refactor everything that isn't cli handling into manager class 
The cli handling belongs in image/index.mjs, but everything that isn't 
cli handling belongs in a middleware class kinda thing. In this case, 
we've created a RenderManager class.
2021-01-18 19:14:03 +00:00

2.3 KiB
Raw Blame History

terrain50-cli

CLI for parsing Ordnance Survey Digital Elevation Model files

This is the CLI for the sister terrain50 library on npm for parsing Ordnance Survey DEM files I also implemented.

Install

Install via npm:

npm install terrain50-cli --global

Usage

The command-line interface works on a subcommand-based system using applause-cli (another package of mine).

Display the usage information like this:

terrain50 --help

If you installed it locally, you'll need to do this:

path/to/node_modules/.bin/terrain50 --help

Environment Variables

Additionally, a number of environment variables are supported.

Variable Purpose
NO_COLOR Disables ANSI escape codes in output (i.e. coloured output). Not recommended unless you have a reason.
QUIET Suppress all output except for warnings and errors (not fully supported everywhere yet)

Notes

image subcommand: --boundaries argument

This argument's purpose is the divide the incoming data into categories so that an AI can be potentially trained on the data (e.g. water depth data, as I'm using). It takes a comma separated list of values like this:

0.1,0.5,1,5

...and turns it into a number of bins like so:

  • -Infinity ≤ value < 0.1
  • 0.1 ≤ value < 0.5
  • 0.5 ≤ value < 1
  • 1 ≤ value < 5
  • 5 ≤ value < Infinity

Each bin is assigned a colour. Then, for each value in the input, it draws the colour that's assigned to the bin that the value fits into.

Read-world use

  • I'm using it for the main Node.js application for my PhD in Computer Science!
  • (Are you using this project? Get in touch by opening an issue)

Contributing

Contributions are welcome as PRs! Don't forget to say that you donate your contribution under the Mozilla Public License 2.0 in your PR comment.

Licence

This project is licensed under the Mozilla Public License 2.0. See the LICENSE file in this repository for the full text.