https://github.com/faradayio/bierstadt
Automated print cartography with node.js and d3.js
https://github.com/faradayio/bierstadt
Last synced: 18 days ago
JSON representation
Automated print cartography with node.js and d3.js
- Host: GitHub
- URL: https://github.com/faradayio/bierstadt
- Owner: faradayio
- License: mit
- Created: 2016-10-16T13:01:00.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-21T00:50:39.000Z (over 8 years ago)
- Last Synced: 2025-02-19T13:38:47.861Z (over 1 year ago)
- Language: JavaScript
- Size: 15.5 MB
- Stars: 1
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bierstadt
Automated thematic print cartography with node.js and d3.js
The Domes of the Yosemite - Albert Bierstadt, 1867
## Install
`npm install bierstadt -g`
## Usage
`bierstadt -t my_project -o svg -c https://gist.githubusercontent.com/wboykinm/e45cc5ec086b63339c6df8c880be9171/raw/4d331ae99eb6f1244ea90ebe12ae40e5d4fb99c7/active_wells.csv`
## Arguments
* `-t, --title` (_REQUIRED_) Project name; will be used to create working directory and files (e.g. '/bierstadt/proj_title/')
* `-o, --output-type` One of `svg` or `pdf` - default is `svg` (PDF not actually supported yet - hold tight)
* `-h, --theme-geometry` (_OPTIONAL_) One of `point` or `polygon`- must be used in tandem with a `*-source` argument:
* `-c, --csv-source` (_OPTIONAL_) Path or URL to `.csv` file of points to be rendered on the output map (e.g. '/home/ubuntu/files/file.csv') - __must be [styled](templates/base.html) and [added](scripts/map.js)__
* `-g, --geojson-source` (_OPTIONAL_) Path or URL to `.geojson` file of features to be rendered on the output map (e.g. '/home/ubuntu/files/file.geojson') - __must be [styled](templates/base.html) and [added](scripts/map.js)__
* `-p, --topojson-source` (_OPTIONAL_) Path or URL to `.topojson` file of features to be rendered on the output map (e.g. '/home/ubuntu/files/file.topojson') - __must be [styled](templates/base.html) and [added](scripts/map.js)__
* `-m, --maki-icon` (_OPTIONAL_) - name of desired [maki icon](https://www.mapbox.com/maki-icons/) for rendering points provided in a `csv-source`
* `-s, --color-scheme` (_OPTIONAL_) - A 3-letter month abbreviation representing the bimodal color scheme you want to use for polygon styling. Default is `jan`.
* `-d, --data-type` (_OPTIONAL_) - For thematic maps, a numeric formatting type of `fraction`, `percent`, or `raw` - defaults to `fraction`