Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 27 additions & 8 deletions docs/api/python.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,39 @@
---
sidebar_position: 1
title: Python API
description: Python API reference for the Context Exploration Engine (CEE) — data assimilation, querying, and retrieval.
---

# Python API — Context Exploration Engine (CEE)
# Context Exploration Engine - Python API Documentation

## Overview

The Context Exploration Engine (CEE) provides a high-level Python API for managing and exploring data contexts in IOWarp. The API is accessible through the `wrp_cee` Python module and offers a simple interface for data assimilation, querying, retrieval, and cleanup operations.

**Key Feature:** The CEE API automatically initializes the IOWarp runtime when you create a `ContextInterface` instance. You don't need to manually initialize Chimaera, CTE, or CAE - the `ContextInterface` constructor handles all of this internally.

## Import
## Installation

### From pip (Recommended)

```bash
pip install iowarp-core
```

This installs the `iowarp_core` package (runtime utilities, CLI) and the `wrp_cee` Python extension (context exploration API). All native dependencies are bundled — no system libraries or build tools required.

### From Source

Build IOWarp with Python bindings enabled:

```bash
cmake --preset=debug -DWRP_CORE_ENABLE_PYTHON=ON
cmake --build build -j$(nproc)
sudo cmake --install build
```

The `wrp_cee` module will be installed to your Python site-packages directory.

### Verification

```python
import iowarp_core
print("IOWarp version:", iowarp_core.get_version())

import wrp_cee
print("CEE API loaded successfully!")
```
Expand Down
2 changes: 1 addition & 1 deletion docs/api/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The Storage API documentation is being developed. This will cover:
Storage operations are currently available through:

1. **Python API** — High-level blob operations via [Python bindings](./python)
2. **C++ SDK** — Native CTE client for high-performance applications (see [Context Transfer Engine](../sdk/context-transfer))
2. **C++ SDK** — Native CTE client for high-performance applications (see [Context Transfer Engine](../sdk/context-transfer-engine/cte))
3. **Docker Runtime** — Container-based deployment with YAML configuration (see [Configuration](../deployment/configuration))

## Configuration
Expand Down
Loading