Skip to main content

License: MIT Poetry GitHub Release DOI

SpacePath

A framework for pathways and molecular sets exploration of annotated Spatial Metabolomics and Lipidomics data

Introduction

SpacePath is a novel bioinformatics framework designed to analyze spatial metabolomics and lipidomics in the context of metabolic pathways. It addresses challenges like compound identification ambiguities and incomplete pathway databases, enabling the mapping of metabolic processes onto tissue architecture.

SpacePath's approach integrates pathway activity scores at the spatial resolution level, and investigates unmapped features with a strategy that exploits the molecular similarity between chemical entities. It overcomes limitations of existing tools that lack spatial resolution capabilities, providing a generalizable solution for tissue-specific metabolic mapping, and facilitating the interpretation of complex mass spectrometry imaging data. When applied to cancer tissues, SpacePath can enhance the understanding of tumor metabolism.

diagram-temporary-spacepath

Notably, SpacePath was applied on a collection of different types of healthy and tumoral tissues, including glioblastoma. By integrating complex spatially resolved lipidomics data and functional sets expressed as pathways or families, the method provided valuable insights about the glioblastoma's metabolic organization, prompting a potential impact on biomarker discovery.

Note: Our method also supports, as input data, the datasets consisting of aligned and recalibrated spectra intensities alongside their annotations, that are obtained from the METASPACE output.

Installing SpacePath

System Requirements

Running SpacePath requires an Unix environment with python 3.10. It was tested under Linux and MacOS environments.

A virtual environment with poetry 2.3.3 is required (see 'Explanation for creating a virtual environment').

Explanation for creating a virtual environment (click to show/hide)

All the install process must occur in a virtual environment with poetry installed.

  • with venv in python:
python3 -m venv spacepath
source spacepath/bin/activate  # activate
pip install poetry==2.3.3
  • alternatiely, with conda, miniconda, micromamba or mamba (command examples below use micromamba):
micromamba create -n spacepath python=3.10.18 -c conda-forge poetry==2.3.3
  • or use the provided .yaml file that is located at tools/spacepath_env.yaml :
micromamba create -f spacepath_env.yaml  

Installation

The full installation process should take less than 15 minutes on a standard computer (dependencies included). Two options are possible.

Option 1: Using a local clone and poetry

First clone SpacePath in your workspace (git clone git@github.com:cbib/SpacePath.git), then, follow the steps specified in the snippet below:

micromamba activate spacepath   # 1. activate your environment
cd SpacePath   # 2. locate into the cloned SpacePath
poetry install  # 3. install SpacePath
pip install sspa==1.0.4  # 4. intall sspa

Option 2: Install via pip

Follow the three steps specified in the snippet below:

micromamba activate spacepath   # activate your environment
pip install SpacePath         
pip install sspa==1.0.4

After the install process

For subsequent use, just activate the environment (e.g. micromamba activate spacepath) as it has all the requirements already installed for running SpacePath.

Using SpacePath

The generic command line to run the pipeline is:

SpacePath $input_file $data_folder $figures_folder

Documentation

Documentation, examples of how to use SpacePath, and the specifics of the datasets used in the analyses are provided in the Wiki page.


For Developers

Code organization of the core folder of SpacePath

The core folder contains the core classes for data and methods that are required for running SpacePath. It is organized into:

  • processing directory contains the implemented high-level functions for the processed dedicated to the measurements and/or the pathways inputs
  • visualization directory contains the implemented high-level scripts to produce figures
  • data directory contains the python classes for data initialization alongside the methods proper to each data class
  • method directory contains the python classes of the configurations and methods that are applied on diverse types of input objects, by invoking 'core/processing' functions
  • anndata_aux directory contains the auxiliary functions for dataset download and formatting into an 'anndata' object

Running unit tests

Place yourself in SpacePath/tests and execute pytest or, alternatively, python -m unittest.


Getting help

For any information or help, you can get in touch with:


LICENSE MIT

Copyright (c) 2025

Johanna Galvis (1,2)    deisy-johanna.galvis-rodriguez@u-bordeaux.fr

Macha Nikolski (1,2)    macha.nikolski@u-bordeaux.fr

(1) CNRS, IBGC - University of Bordeaux,
1, rue Camille Saint-Saens, Bordeaux, France

(2) CBiB - University of Bordeaux,
146, rue Leo Saignat, Bordeaux, France

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.

Metadata

Release files for SpacePath 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for SpacePath 0.1.0
File Size Uploaded Provenance
spacepath-0.1.0.tar.gz 4.5 MB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for SpacePath 0.1.0
File Interpreter ABI Platform
spacepath-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 9.2 MB

Release files / spacepath-0.1.0.tar.gz

Download URL spacepath-0.1.0.tar.gz
Size 4.5 MB
Tags Source
SHA-256 checksum
How to use checksums
f11c0c3e14f1813922734112142885ba9873edc2c3002fcb0efd85bd667bf4e4
BLAKE2b-256 checksum
How to use checksums
4451efd58fec357e06c5b04e20ff7c5619991f78cdf7af3bd3c32e9f555f85e1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / spacepath-0.1.0-py3-none-any.whl

Download URL spacepath-0.1.0-py3-none-any.whl
Size 4.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
8df377d1256800cacd3bdafd0cafe8ace3e4a5debe64890caa2dd58bb8b52dcf
BLAKE2b-256 checksum
How to use checksums
ba743877baa9dc53b63252572e02da09c53698075621f02380232646e9ade11a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Security for SpacePath 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for spacepath-0.1.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page