Skip to content

Commit ab27cf8

Browse files
akougkascursoragent
andcommitted
Rebuild documentation site from scratch with Docusaurus 3.9.2
Fresh Docusaurus 3 project replacing the hacked-together extraction from the old iowarp.github.io repo. Key changes: - Clean Docusaurus 3.9.2 scaffold with TypeScript - IOWarp brand theme (teal/orange/cream) consistent with toolkit.iowarp.ai - Neobrutalist design accents on nav/footer, clean readable doc content - Beautiful landing page with section cards at docs.iowarp.ai root - Restructured docs: getting-started, clio-kit, sdk, api, deployment, faq - Proper frontmatter with descriptions on all pages - Tabs for installation methods (Docker/Native/Spack) - Tabs for IDE integration (Cursor/Claude Code/VS Code/Claude Desktop) - Removed 80+ unused static images (papers, demos, logos) - Clean MCP servers reference page with summary tables - GitHub Actions deploy workflow for GitHub Pages - robots.txt, llms.txt, CNAME for docs.iowarp.ai - Zero build warnings, zero broken links Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent c0bdd6b commit ab27cf8

125 files changed

Lines changed: 1407 additions & 2653 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,3 @@
1818
npm-debug.log*
1919
yarn-debug.log*
2020
yarn-error.log*
21-
22-
.playwright-mcp
23-
24-
.specify
25-
.cursor
26-
.husky
27-
.lintstagedrc
28-
.claude
29-
specs/
30-
.windsurf/
31-
32-
vision-sources/
33-
34-
# Archived shadow pages (not compiled, content preserved locally)
35-
src/pages/_archived/

LICENSE

Lines changed: 0 additions & 28 deletions
This file was deleted.

README.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,47 @@
11
# IOWarp Documentation
22

3-
Technical documentation for the [IOWarp](https://iowarp.ai) context engineering platform.
3+
Technical documentation for the [IOWarp](https://iowarp.ai) context orchestration platform, served at **[docs.iowarp.ai](https://docs.iowarp.ai)**.
44

5-
**Live site**: [docs.iowarp.ai](https://docs.iowarp.ai)
5+
Built with [Docusaurus 3](https://docusaurus.io/) and deployed via GitHub Pages.
66

77
## Development
88

99
```bash
1010
# Install dependencies
1111
npm install
1212

13-
# Start dev server
13+
# Start dev server (http://localhost:4000)
1414
npm start
1515

1616
# Build for production
1717
npm run build
18+
19+
# Serve production build locally
20+
npm run serve
1821
```
1922

2023
## Structure
2124

2225
```
23-
docs/ # Documentation markdown files
24-
getting-started/ # Installation and quick start
25-
deployment/ # HPC cluster deployment
26-
agent-toolkit/ # CLIO Kit MCP servers
27-
sdk/ # IOWarp SDK (Hermes, Chimaera, CLIO Transfer)
28-
api/ # Python and Storage API reference
29-
faq/ # Troubleshooting
30-
static/ # Static assets
31-
docusaurus.config.ts # Site configuration
32-
sidebars.ts # Sidebar navigation
26+
docs/
27+
├── intro.md # Welcome & overview
28+
├── getting-started/ # Installation, quick start
29+
├── clio-kit/ # MCP servers reference
30+
├── sdk/ # IPC, runtime modules, CTE, CAE
31+
├── api/ # Python API, agent API, storage API
32+
├── deployment/ # Configuration, HPC, performance
33+
├── faq.md # FAQ & troubleshooting
34+
└── tutorials.md # Step-by-step guides
3335
```
3436

3537
## Related Sites
3638

37-
- [iowarp.ai](https://iowarp.ai) — Main project website (Astro)
38-
- [toolkit.iowarp.ai](https://toolkit.iowarp.ai) — CLIO Kit MCP server showcase (Docusaurus)
39-
- [docs.iowarp.ai](https://docs.iowarp.ai) — This site (Docusaurus)
39+
| Site | URL | Repository |
40+
|------|-----|-----------|
41+
| IOWarp Website | [iowarp.ai](https://iowarp.ai) | [iowarp/iowarp.github.io](https://github.com/iowarp/iowarp.github.io) |
42+
| CLIO Kit Showcase | [toolkit.iowarp.ai](https://toolkit.iowarp.ai) | [iowarp/clio-kit](https://github.com/iowarp/clio-kit) |
43+
| Documentation | [docs.iowarp.ai](https://docs.iowarp.ai) | [iowarp/docs](https://github.com/iowarp/docs) |
4044

4145
## License
4246

43-
BSD 3-Clause License. See [LICENSE](LICENSE).
47+
BSD 3-Clause [Gnosis Research Center](https://grc.iit.edu/), Illinois Institute of Technology

docs/agent-toolkit/mcp.md

Lines changed: 0 additions & 406 deletions
This file was deleted.

docs/api/agents.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,30 @@
1+
---
2+
sidebar_position: 2
3+
title: Agent API
4+
description: API reference for integrating AI agents with the IOWarp runtime.
5+
---
6+
17
# Agent API
28

3-
*Coming soon*
9+
:::info Coming Soon
10+
The Agent API documentation is being developed. This will cover:
11+
12+
- **CLIO Agent SDK** — Programmatic agent orchestration
13+
- **Context Engineering API** — Building custom context pipelines
14+
- **Workflow Definitions** — Declarative scientific workflow specifications
15+
- **Event System** — Subscribe to runtime events and telemetry
16+
:::
17+
18+
## Current Integration Points
19+
20+
AI agents currently interact with IOWarp through:
21+
22+
1. **CLIO Kit MCP Servers** — 16 servers with 150+ tools via the [Model Context Protocol](../clio-kit/mcp-servers)
23+
2. **Python API** — Direct runtime interaction via the [Python bindings](./python)
24+
3. **CLI Tools** — Command-line utilities for runtime management
25+
26+
## Resources
27+
28+
- [CLIO Agent Overview](https://iowarp.ai/platform/clio-agent/) — Architecture and design
29+
- [CLIO Kit](https://toolkit.iowarp.ai) — Interactive MCP server showcase
30+
- [GitHub Issues](https://github.com/iowarp/iowarp/issues) — Request API features
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Context Exploration Engine - Python API Documentation
1+
---
2+
sidebar_position: 1
3+
title: Python API
4+
description: Python API reference for the Context Exploration Engine (CEE) — data assimilation, querying, and retrieval.
5+
---
6+
7+
# Python API — Context Exploration Engine (CEE)
28

39
## Overview
410

docs/api/storage.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
1+
---
2+
sidebar_position: 3
3+
title: Storage API
4+
description: API reference for the IOWarp storage layer and Context Transfer Engine.
5+
---
6+
17
# Storage API
28

3-
*Coming soon*
9+
:::info Coming Soon
10+
The Storage API documentation is being developed. This will cover:
11+
12+
- **CTE Client API** — Blob Put/Get/Delete operations
13+
- **Multi-Tier Storage** — Programmatic tier management
14+
- **Data Placement Engine** — Custom placement policies
15+
- **Streaming API** — Chunked reads/writes for large datasets
16+
:::
17+
18+
## Current Access Methods
19+
20+
Storage operations are currently available through:
21+
22+
1. **Python API** — High-level blob operations via [Python bindings](./python)
23+
2. **C++ SDK** — Native CTE client for high-performance applications (see [Context Transfer Engine](../sdk/context-transfer))
24+
3. **Docker Runtime** — Container-based deployment with YAML configuration (see [Configuration](../deployment/configuration))
25+
26+
## Configuration
27+
28+
Storage tiers are configured in `wrp_conf.yaml`. See the [Configuration Reference](../deployment/configuration) for details on:
29+
30+
- RAM, NVMe, SSD, and HDD tier setup
31+
- Data placement engine (`max_bw`, `round_robin`, `random`)
32+
- Capacity limits and scoring

docs/clio-kit/mcp-servers.md

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
2+
sidebar_position: 1
3+
title: MCP Servers
4+
description: "16 specialized Model Context Protocol servers for scientific computing — 150+ tools for HDF5, Slurm, ParaView, ArXiv, and more."
5+
---
6+
7+
# CLIO Kit — MCP Servers
8+
9+
**16 specialized MCP servers for scientific computing — 150+ tools**
10+
11+
CLIO Kit provides AI agents with direct access to HPC infrastructure, scientific data formats, and research workflows through [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) servers.
12+
13+
:::tip
14+
For the interactive MCP showcase, visit [toolkit.iowarp.ai](https://toolkit.iowarp.ai).
15+
:::
16+
17+
## Quick Start
18+
19+
```bash
20+
# Install and run any MCP server
21+
uvx iowarp-agent-toolkit mcp-server hdf5
22+
uvx iowarp-agent-toolkit mcp-server pandas
23+
uvx iowarp-agent-toolkit mcp-server slurm
24+
25+
# List all available servers
26+
uvx iowarp-agent-toolkit mcp-servers
27+
```
28+
29+
## Available Servers
30+
31+
### Data I/O & Visualization (5 servers, 56+ tools)
32+
33+
| Server | Tools | Description |
34+
|--------|-------|-------------|
35+
| **HDF5** | 27 | HDF5 file operations with AI-powered insights, LRU caching, streaming |
36+
| **Pandas** | 15 | CSV data analysis, statistical summaries, data cleaning |
37+
| **ADIOS** | 5 | Scientific data I/O for BP5 format |
38+
| **Parquet** | 4 | High-performance columnar data processing |
39+
| **ParaView** | 29 | 3D scientific visualization, isosurfaces, streamlines |
40+
41+
### HPC Integration (4 servers, 59+ tools)
42+
43+
| Server | Tools | Description |
44+
|--------|-------|-------------|
45+
| **Slurm** | 13 | Job submission, monitoring, cluster analytics |
46+
| **Jarvis** | 25+ | HPC workflow orchestration, pipeline management |
47+
| **Lmod** | 10 | HPC module system management |
48+
| **Node Hardware** | 11 | CPU, GPU, memory, disk, network monitoring |
49+
50+
### Research Discovery (2 servers, 16+ tools)
51+
52+
| Server | Tools | Description |
53+
|--------|-------|-------------|
54+
| **ArXiv** | 13 | Paper search, metadata, BibTeX export, citation networks |
55+
| **NDP** | 3 | National Data Platform dataset discovery |
56+
57+
### System Monitoring (2 servers, 14+ tools)
58+
59+
| Server | Tools | Description |
60+
|--------|-------|-------------|
61+
| **Darshan** | 10 | I/O performance analysis, bandwidth, bottleneck detection |
62+
| **ChronoLog** | 4 | Session logging and context sharing |
63+
64+
### Utilities (3 servers, 20+ tools)
65+
66+
| Server | Tools | Description |
67+
|--------|-------|-------------|
68+
| **Plot** | 6 | Data visualization (line, bar, scatter, heatmap) |
69+
| **Compression** | 1 | File compression utilities |
70+
| **Parallel Sort** | 13 | Log processing, pattern detection, filtering |
71+
72+
## IDE Integration
73+
74+
import Tabs from '@theme/Tabs';
75+
import TabItem from '@theme/TabItem';
76+
77+
<Tabs>
78+
<TabItem value="cursor" label="Cursor" default>
79+
80+
Add to `~/.cursor/mcp.json`:
81+
82+
```json
83+
{
84+
"mcpServers": {
85+
"hdf5-mcp": {
86+
"command": "uvx",
87+
"args": ["iowarp-agent-toolkit", "mcp-server", "hdf5"]
88+
},
89+
"pandas-mcp": {
90+
"command": "uvx",
91+
"args": ["iowarp-agent-toolkit", "mcp-server", "pandas"]
92+
},
93+
"slurm-mcp": {
94+
"command": "uvx",
95+
"args": ["iowarp-agent-toolkit", "mcp-server", "slurm"]
96+
}
97+
}
98+
}
99+
```
100+
101+
[Cursor MCP docs →](https://docs.cursor.com/context/model-context-protocol)
102+
103+
</TabItem>
104+
<TabItem value="claude-code" label="Claude Code">
105+
106+
```bash
107+
claude mcp add hdf5-mcp -- uvx iowarp-agent-toolkit mcp-server hdf5
108+
claude mcp add pandas-mcp -- uvx iowarp-agent-toolkit mcp-server pandas
109+
claude mcp add slurm-mcp -- uvx iowarp-agent-toolkit mcp-server slurm
110+
```
111+
112+
[Claude Code MCP docs →](https://code.claude.com/docs/en/mcp)
113+
114+
</TabItem>
115+
<TabItem value="vscode" label="VS Code">
116+
117+
Add to your VS Code MCP config:
118+
119+
```json
120+
"mcp": {
121+
"servers": {
122+
"hdf5-mcp": {
123+
"type": "stdio",
124+
"command": "uvx",
125+
"args": ["iowarp-agent-toolkit", "mcp-server", "hdf5"]
126+
},
127+
"pandas-mcp": {
128+
"type": "stdio",
129+
"command": "uvx",
130+
"args": ["iowarp-agent-toolkit", "mcp-server", "pandas"]
131+
}
132+
}
133+
}
134+
```
135+
136+
[VS Code MCP docs →](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
137+
138+
</TabItem>
139+
<TabItem value="claude-desktop" label="Claude Desktop">
140+
141+
Edit `claude_desktop_config.json`:
142+
143+
```json
144+
{
145+
"mcpServers": {
146+
"hdf5-mcp": {
147+
"command": "uvx",
148+
"args": ["iowarp-agent-toolkit", "mcp-server", "hdf5"]
149+
},
150+
"arxiv-mcp": {
151+
"command": "uvx",
152+
"args": ["iowarp-agent-toolkit", "mcp-server", "arxiv"]
153+
}
154+
}
155+
}
156+
```
157+
158+
[Claude Desktop MCP docs →](https://modelcontextprotocol.io/quickstart/user)
159+
160+
</TabItem>
161+
</Tabs>
162+
163+
## Repository
164+
165+
- **GitHub**: [github.com/iowarp/clio-kit](https://github.com/iowarp/clio-kit)
166+
- **PyPI**: [pypi.org/project/clio-kit](https://pypi.org/project/clio-kit/)
167+
- **Interactive Showcase**: [toolkit.iowarp.ai](https://toolkit.iowarp.ai)

docs/deployment/configuration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
sidebar_position: 1
3+
title: Configuration
4+
description: Complete configuration reference for IOWarp runtime and CTE deployments.
5+
---
6+
17
# Configuration Reference
28

39
This document describes how to configure IOWarp deployments.

docs/deployment/hpc-cluster.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
sidebar_position: 2
3+
title: HPC Cluster
4+
description: Deploying IOWarp on HPC clusters with Spack and containers.
5+
---
6+
17
# HPC Cluster Deployment
28

39
## Spack (Manual)

0 commit comments

Comments
 (0)