Metadata-Version: 2.1
Name: spacenet
Version: 0.0.2
Summary: A Python package for spatial analysis of spatial networks.
Project-URL: Homepage, https://www.spacenet-python.com
Project-URL: Documentation, https://www.spacenet-python.com
Project-URL: Repository, https://github.com/joshwillmoore1/spacenet
Author-email: Joshua Moore <joshua.moore@maths.ox.ac.uk>
Maintainer-email: Joshua Moore <joshua.moore@maths.ox.ac.uk>
License: MIT License
        
        Copyright (c) 2026 Joshua Moore
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: matplotlib>=3.0
Requires-Dist: networkx>=3.4
Requires-Dist: numba>=0.61.2
Requires-Dist: numpy>=2.0
Requires-Dist: pandas>=2.3.3
Requires-Dist: scikit-network>=0.33.0
Requires-Dist: scipy>=1.14.1
Requires-Dist: setuptools>=72.1.0
Requires-Dist: tqdm>=4.66.4
Description-Content-Type: text/markdown

# SpaceNet

[![Python package](https://github.com/joshwillmoore1/spacenet/actions/workflows/python-package.yml/badge.svg)](https://github.com/joshwillmoore1/spacenet/actions/workflows/python-package.yml)
[![License](https://img.shields.io/badge/license-MIT-green.svg)]()

<img width="3229" height="375" alt="docs_banner" src="https://github.com/user-attachments/assets/38c2e128-6a9d-48ce-aa5f-2b02b61fae10" />

**SpaceNet** is an open-source Python package for the spatial analysis of **spatially embedded networks**.

The package provides tools for quantifying the geometry, topology, spatial structure and statistical properties of spatial networks. SpaceNet is designed to support both applied analyses and the development of new methodology in spatial network analysis.


## Installation

Install the latest release from PyPI:

```bash
pip install spacenet
```

Or install the development version directly from GitHub:

```bash
git clone https://github.com/joshwillmoore1/spacenet.git
cd spacenet
pip install -e .
```

---

## Quick Example

```python
import spacenet as sn

# Load the spiral dataset and extract the 'x' and 'y' columns as points
spiral_data = sn.datasets.load_dataset('spiral')
points = spiral_data[['x', 'y']].to_numpy()

# generate a spatial network
G = sn.utils.spatial_network_from_points(points,max_edge_distance=50)

# plot the spatial network
sn.utils.plot_spatial_network(G)
```

See the documentation for additional examples and tutorials at www.spacenet-python.com/latest/.

---

## Citation

If you use SpaceNet in your research, please cite the accompanying publication.

```text
Citation information will be added upon publication.
```

---

## Contributing

Contributions are welcome!

If you encounter a bug, have a feature request, or would like to contribute code or documentation, please open an issue or submit a pull request.

---

## License

SpaceNet is released under the BSD 3-Clause License. See the `LICENSE` file for details.
