Python API Overview

Python API Overview#

ARGscape provides a Python API for visualizing and analyzing tree sequences directly from your scripts and Jupyter notebooks.

Installation#

# Basic installation (2D visualization only)
pip install argscape

# Add 3D visualization spatial inference
pip install argscape[spatial]

# Full installation - adds static image export and benchmarking (requires playwright)
pip install argscape[all]

Quick Start#

Visualization#

import argscape
import msprime

# Create or load a tree sequence
ts = msprime.sim_ancestry(samples=20, sequence_length=10000, random_seed=42)

# Visualize
viz = argscape.visualize(ts)
viz.show()       # Open in browser
viz.display()    # Render in Jupyter notebook
viz.export("figure.png")  # Export to file (requires playwright)

Spatial Inference#

import argscape

# Run spatial inference (requires sample locations)
result = argscape.infer(ts, method="fastgaia")

# Visualize inferred locations in 3D
argscape.visualize(result.ts, mode="spatial_3d").show()

Core Functions#

Function

Description

argscape.visualize()

Create interactive visualizations from tree sequences

argscape.infer()

Run spatial or temporal inference

argscape.available_methods()

Check which inference methods are available

Core Classes#

Class

Description

VizResult

Visualization result with show/display/export methods

InferResult

Inference result containing tree sequence and metadata

Visualization Modes#

ARGscape supports two visualization modes:

2D Force Graph (mode="force_graph")#

Default mode. Creates an interactive network visualization with:

  • Nodes positioned by time (vertical) and sample order (horizontal)

  • Drag-and-drop node positioning

  • Click interactions for focal node selection

  • Mutation markers

viz = argscape.visualize(ts, mode="force_graph")

3D Spatial (mode="spatial_3d")#

For tree sequences with geographic coordinates:

  • X-Y plane shows spatial locations

  • Z-axis shows time

  • Geographic shapefile backgrounds

  • Camera controls for rotation and zoom

viz = argscape.visualize(ts, mode="spatial_3d")

Themes#

Four built-in themes are available:

Theme

Description

"liquid"

Default. Light theme with glassmorphism effects

"tskit"

Dark theme with cyan/green accents

"grayscale"

Black and white for publications

"paper"

Optimized for print figures

 
viz = argscape.visualize(ts, theme="paper")

See Themes for detailed theme information.

Workflow Examples#

From Web App to Python#

Use the web app to interactively explore your data, then export settings as a Python script:

  1. Configure visualization in web app

  2. Click Export → Python to download script

  3. Run the script for batch processing or reproducibility

# Generated script captures your web app settings
viz = argscape.visualize(
    ts,
    theme="liquid",
    max_samples=50,
    sample_order="dagre",
    show_mutations=True,
)
viz.export("figure.png")

Publication Figure#

import argscape

viz = argscape.visualize(
    ts,
    theme="paper",
    width=1000,
    height=700,
    sample_order="dagre",
    show_sample_ids=True,
    edge_width=1.5,
)
viz.export("figure.pdf", dpi=300)

Explore Specific Lineage#

import argscape

# Focus on ancestors of a sample
viz = argscape.visualize(
    ts,
    focal_node=5,
    focal_mode="ancestors",
)
viz.show()

Inference and Visualization#

import argscape

# Infer locations and visualize
result = argscape.infer(ts, method="fastgaia")
argscape.visualize(
    result.ts,
    mode="spatial_3d",
    shapefile="countries.shp",
    location_crs="EPSG:4326",
).show()

API Reference#

On this page