Usage

Installation

pip install EcoInteract

Quick Start

The main function exposed by this library is get_interaction_data, available in the getgraph module.

get_interaction_data

Builds the interaction graph for a target species.

Signature:

get_interaction_data(
    target_species: str,
    search_depth: int = 3,
    interaction_type: str | list[str] | None = None,
) -> nx.DiGraph | None

Example:

from EcoInteract import get_interaction_data

# Fetch interaction data for a species
data = get_interaction_data(target_species="wolf")

# With custom depth and interaction types
data = get_interaction_data(
    target_species="wolf",
    search_depth=5,
    interaction_type=["predation", "competition"]
)

Parameters:

• target_species (str): The species to search interactions for
• search_depth (int): Depth of the interaction graph traversal (default: 3)
• interaction_type (str | list[str] | None): Filter by interaction type(s). If None, returns all interactions

Returns:

• A directed graph (nx.DiGraph) containing ecological relationships, or None if no interactions are found

Documentation

For more information, refer to the module docstrings and source code.