Documentation#

MuSpAn is organised into several modules, each of which provides tools for working with different aspects of spatial data and analysis. The organisation of the package is designed to group tools and spatial analysis methods that are closely related in terms of their functionality and mathematical underpinnings.

Subpackage

Description

domain

A container for spatial data

objects

Objects that can be used to represent spatial data

query

Querying domain objects

shape_operations

Manipulating shape objects

spatial_statistics

Spatial statistics

region_based

Region-based analysis of spatial data

networks

Network analysis for spatial data

geometry

Geometric descriptors of shape-like objects

topology

Topological data analysis

distribution

Distribution analysis of spatial data

summary_statistics

Non-spatial summary statistics

visualise

Visualisation

io

Data input and output helper operations

datasets

Datasets for testing and demonstration

helpers

Helper functions for spatial analysis and data manipulation

Import functions from MuSpAn#

All of the functions and classes in the MuSpAn package are publically available and can be imported using the following import statement:

import muspan

Or alternatively, you can import specific functions or classes from the package. For example, if we only wanted use a specific function, say network_distance from the networks module, we could import it as follows:

from muspan.networks import network_distance
distance = network_distance(...)

MuSpAn reference list#

All of the modules are listed below, and each module has its own documentation page that provides a detailed description of the functions and classes that are available in that module.