Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌿 EcoInteract

Build ecological interaction networks from GloBI with a single function.

PyPI Python License

Part of the EcoToolBox ecosystem 🌿


✨ Overview

EcoInteract is a lightweight Python library for retrieving ecological interaction data from the Global Biotic Interactions (GloBI) database.

With a single function call you can retrieve food webs, pollination networks, host-parasite relationships, competition, mutualism and many other ecological interactions.

The library automatically constructs a NetworkX directed graph, making it easy to perform ecological network analysis or integrate interaction data into biodiversity workflows. :contentReference[oaicite:0]{index=0}


🚀 Features

  • 🌎 Retrieve interaction data directly from GloBI
  • 🕸️ Build NetworkX graphs automatically
  • 🔍 Filter by interaction type
  • 📈 Control search depth
  • 🐍 Simple Python API
  • 🌿 Designed to integrate with EcoLab and EcoObs

📦 Installation

pip install ecointeract

Available on PyPI. :contentReference[oaicite:1]{index=1}


⚡ Quick Start

from EcoInteract import get_interaction_data

graph = get_interaction_data(
    target_species="Panthera onca"
)

print(graph.nodes())

📚 Example

Retrieve only pollination interactions.

from EcoInteract import get_interaction_data

graph = get_interaction_data(
    target_species="Apis mellifera",
    interaction_type="pollination"
)

⚙️ Parameters

Parameter Description
target_species Scientific or common species name
search_depth Graph traversal depth
interaction_type Optional interaction filter

🌱 Supported Interaction Types

Examples include:

  • 🐝 Pollination
  • 🦅 Predation
  • 🌱 Herbivory
  • 🍄 Symbiosis
  • 🤝 Mutualism
  • 🦠 Parasitism
  • ⚔️ Competition

🔄 Example Workflow

Species
    │
    ▼
EcoInteract
    │
    ▼
GloBI API
    │
    ▼
NetworkX Graph
    │
    ▼
Visualization / Analysis / Machine Learning

🌿 EcoToolBox Ecosystem

EcoInteract is part of the EcoToolBox ecosystem.

Project Description
🖥️ EcoLab Species Distribution Modeling
🌍 EcoEnv Environmental variables
🦋 EcoObs Species occurrences
🌿 EcoInteract Ecological interactions

📄 Citation

If EcoInteract contributes to your research, please cite:

Ane Simões et al.

(BibTeX coming soon.)


🤝 Contributing

Pull requests are welcome.

Bug reports and feature requests can be submitted through GitHub Issues.


📜 License

MIT License.

About

No description or website provided.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages