pysal.contrib – Contributed ModulesΒΆ

Intro

The PySAL Contrib library contains user contributions that enhance PySAL, but are not fit for inclusion in the general library. The primary reason a contribution would not be allowed in the general library is external dependencies. PySAL has a strict no dependency policy (aside from Numpy/Scipy). This helps ensure the library is easy to install and maintain.

However, this policy often limits our ability to make use of existing code or exploit performance enhancements from C-extensions. This contrib module is designed to alleviate this problem. There are no restrictions on external dependencies in contrib.

Ground Rules

  1. Contribs must not be used within the general library.
  2. Explicit imports: each contrib must be imported manually.
  3. Documentation: each contrib must be documented, dependencies especially.

Contribs

Currently the following contribs are available:

  1. World To View Transform – A class for modeling viewing windows, used by Weights Viewer.

    • New in version 1.3.

    • Path: pysal.contrib.weights_viewer.transforms

    • Requires: None

  2. Weights Viewer – A Graphical tool for examining spatial weights.

    • New in version 1.3.

    • Path: pysal.contrib.weights_viewer.weights_viewer

    • Requires: wxPython

  3. Shapely Extension – Exposes shapely methods as standalone functions

    • New in version 1.3.

    • Path: pysal.contrib.shapely_ext

    • Requires: shapely

  4. Shared Perimeter Weights – calculate shared perimeters weights.

    • New in version 1.3.

    • Path: pysal.contrib.shared_perimeter_weights

    • Requires: shapely

  5. Visualization – Lightweight visualization layer (Project page).

    • New in version 1.5.

    • Path: pysal.contrib.viz

    • Requires: matplotlib

  6. Clusterpy – Spatially constrained clustering.

    • New in version 1.8.

    • Path: pysal.contrib.clusterpy

    • Requires: clusterpy

  7. Pandas utilities – Tools to work with spatial file formats using pandas.

    • New in version 1.8.

    • Path: pysal.contrib.pdutilities

    • Requires: `pandas`_

  8. Spatial Interaction – Tools for spatial interaction (SpInt) modeling.

  • New in version 1.10.

  • Path: pysal.contrib.spint

  • Requires: `pandas`_

  1. Githooks – Optional hooks for git to make development on PySAL easier

    • New in version 1.10.

    • Path: pysal.contrib.githooks (Note: not importable)

    • Requires: git

  2. Handler – A model ingester to standardize model extension

  • New in version 1.10.

  • Path: pysal.contrib.handler

  • Requires: None

  • Optional: patsy