Skip to main content

calculate bins on spatial data

Project description

Command line tool for adding data classes to geodata files.

Built on top of Fiona and Pysal mapclassify.


Requires GDAL. Numpy and Pysal will be installed if not available.

pip install breaks

These are the breaks

Usage: breaks [OPTIONS] input data-field output

  Write a geodata file with bins based on a data field

  -m, --method METHOD     Binning method:
                          quantiles (default)
  -b, --bin-field FIELD   name of new field
  -n, --norm-field FIELD  Normalize (divide) bin-field by this name field
  -k COUNT                Number of bins (default: 5)
  -B, --bins TEXT         Comma-separated list of breaks (a series of upper-
  -i, --id-field FIELD    If given, only write this field, bin-field, and
                          data-field (and norm-field, if given).
  --version               Show the version and exit.
  --help                  Show this message and exit.

Add quintile bins on ‘fieldname’:

breaks data.shp fieldname data_binned.shp

This writes a file called data_binned.shp which is a copy of data.shp, but with an additional bin field, which contains a number from 0 to 4 (it will contain NULL values for rows with missing data).

Add decile bins on ‘fieldname’:

breaks -k 10 data.shp fieldname data_binned.geojson

Add five Fisher-Jenks bins on ‘fieldname’:

breaks --method fisher_jenks data.json fieldname data_binned.json

Add decile bins on ‘fieldname’ to a field called ‘mybin’:

breaks --bin-field mybin data.geojson fieldname data_binned.geojson

Divide one field by another. If you have more complicated manipulations you would like to work, alter your data with ogr2ogr or another tool.

# Calculates bins for population / area
breaks data.geojson population data_binned.geojson --norm-field area

Add custom bins on ‘fieldname’:

breaks --bins 50,75,150,250,500 data.geojson fieldname data_binned.shp

(Give the upper-bounds as a comma-separated list.)

Only write an ID field and the data fields:

breaks --id-field GEOID data.shp field1 data_lookup.shp


Copyright 2016 Neil Freeman. Available under the GNU Public License.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

breaks-0.2.0-py2.py3-none-any.whl (7.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page