Skip to content
Merged
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
2 changes: 1 addition & 1 deletion docs/api/agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ AI agents currently interact with IOWarp through:

- [CLIO Agent Overview](https://iowarp.ai/platform/clio-agent/) — Architecture and design
- [CLIO Kit](https://docs.iowarp.ai) — Interactive MCP server showcase
- [GitHub Issues](https://github.com/iowarp/iowarp/issues) — Request API features
- [GitHub Issues](https://github.com/iowarp/clio-core/issues) — Request API features
12 changes: 6 additions & 6 deletions docs/deployment/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ Size values throughout the file accept: `B`, `KB`, `MB`, `GB`, `TB` (case-insens

| Parameter | Default | Description |
|-----------|---------|-------------|
| `port` | `5555` | ZeroMQ RPC listener port. Must match across all cluster nodes. |
| `port` | `9413` | ZeroMQ RPC listener port. Must match across all cluster nodes. Can be overridden by `CHI_PORT` env var. |
| `neighborhood_size` | `32` | Maximum nodes queried when splitting range queries. |
| `hostfile` | *(none)* | Path to a file listing cluster node IPs/hostnames, one per line. Required for multi-node deployments. |
| `wait_for_restart` | `30` | Seconds to wait for peer nodes during startup. |
| `wait_for_restart_poll_period` | `1` | Seconds between connection retry attempts during startup. |

```yaml
networking:
port: 5555
port: 9413
neighborhood_size: 32
# hostfile: /etc/iowarp/hostfile # Multi-node only
wait_for_restart: 30
Expand Down Expand Up @@ -261,7 +261,7 @@ All fields are optional and override compile-time defaults.

```yaml
networking:
port: 5555
port: 9413

runtime:
num_threads: 4
Expand Down Expand Up @@ -291,7 +291,7 @@ compose:

```yaml
networking:
port: 5555
port: 9413

runtime:
num_threads: 16
Expand Down Expand Up @@ -334,7 +334,7 @@ compose:

```yaml
networking:
port: 5555
port: 9413
neighborhood_size: 32
hostfile: /etc/iowarp/hostfile

Expand Down Expand Up @@ -383,7 +383,7 @@ services:
volumes:
- ./chimaera.yaml:/home/iowarp/.chimaera/chimaera.yaml:ro
ports:
- "5555:5555"
- "9413:9413"
mem_limit: 8g
command: ["chimaera", "runtime", "start"]
restart: unless-stopped
Expand Down
9 changes: 8 additions & 1 deletion docs/deployment/hpc-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ The following environment variables control runtime behavior. Set them before st
export CHI_SERVER_CONF=/etc/iowarp/config.yaml
```

### Networking Overrides

| Variable | Default | Description |
|----------|---------|-------------|
| `CHI_PORT` | `9413` | Override the RPC port. Takes priority over the YAML `networking.port` setting. |
| `CHI_SERVER_ADDR` | `127.0.0.1` | Override the server address that clients connect to. |

### IPC Transport Mode

| Variable | Default | Description |
Expand Down Expand Up @@ -107,7 +114,7 @@ Reference it in your config:

```yaml
networking:
port: 5555
port: 9413
hostfile: /etc/iowarp/hostfile
```

Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ IOWarp is released under the [BSD 3-Clause License](https://opensource.org/licen
### Where can I get help?

- **Zulip Chat**: [iowarp.zulipchat.com](https://iowarp.zulipchat.com)
- **GitHub Issues**: [github.com/iowarp/iowarp/issues](https://github.com/iowarp/iowarp/issues)
- **GitHub Issues**: [github.com/iowarp/clio-core/issues](https://github.com/iowarp/clio-core/issues)
- **Discussions**: [github.com/orgs/iowarp/discussions](https://github.com/orgs/iowarp/discussions)
- **Email**: grc@illinoistech.edu

Expand Down
13 changes: 7 additions & 6 deletions docs/getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ This uses conda internally to manage dependencies and produces a full-featured
build with all optional components.

```bash
git clone --recurse-submodules https://github.com/iowarp/iowarp-core.git
cd iowarp-core
git clone --recurse-submodules https://github.com/iowarp/clio-core.git
cd clio-core
./install.sh
```

Expand Down Expand Up @@ -73,7 +73,7 @@ docker pull iowarp/deploy-cpu:latest
Run the container:

```bash
docker run -d -p 5555:5555 --memory=8g --name iowarp iowarp/deploy-cpu:latest chimaera runtime start
docker run -d -p 9413:9413 --memory=8g --name iowarp iowarp/deploy-cpu:latest chimaera runtime start
```

### Using Docker Compose
Expand All @@ -89,7 +89,7 @@ services:
volumes:
- ./chimaera.yaml:/home/iowarp/.chimaera/chimaera.yaml:ro
ports:
- "5555:5555"
- "9413:9413"
mem_limit: 8g
command: ["chimaera", "runtime", "start"]
restart: unless-stopped
Expand Down Expand Up @@ -120,8 +120,9 @@ echo ". ${PWD}/share/spack/setup-env.sh" >> ~/.bashrc
2. Add the IOWarp repository:

```bash
git clone https://github.com/iowarp/iowarp-install.git
spack repo add iowarp-install/iowarp-spack
git clone --recurse-submodules https://github.com/iowarp/clio-core.git
cd clio-core
spack repo add installers/spack
```

3. Install IOWarp:
Expand Down
6 changes: 4 additions & 2 deletions docs/getting-started/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ The runtime resolves its configuration in this order:
| 2 | `~/.chimaera/chimaera.yaml` |
| 3 | Built-in defaults |

The default configuration starts **4 worker threads** on **port 5555** and
The default configuration starts **4 worker threads** on **port 9413** and
composes three modules automatically:

| Module | Purpose |
Expand Down Expand Up @@ -175,6 +175,8 @@ Done!
|----------|-------------|
| `CHI_SERVER_CONF` | Path to YAML configuration file (highest priority) |
| `CHI_IPC_MODE` | Transport: `SHM` (shared memory), `TCP` (default), `IPC` (Unix socket) |
| `CHI_PORT` | Override the RPC port (default: `9413`). Takes priority over YAML config. |
| `CHI_SERVER_ADDR` | Override the server address clients connect to (default: `127.0.0.1`). |
| `HSHM_LOG_LEVEL` | Logging verbosity: `debug`, `info`, `warning`, `error`, `fatal` |

## Next Steps
Expand All @@ -190,7 +192,7 @@ Done!

## Support

- Open an issue on the [GitHub repository](https://github.com/iowarp/core)
- Open an issue on the [GitHub repository](https://github.com/iowarp/clio-core)
- Join the [Zulip Chat](https://iowarp.zulipchat.com)
- Visit the [IOWarp website](https://iowarp.ai)
- Email: grc@illinoistech.edu
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ IOWarp consists of three layers:
## Need Help?

- **Community** — [Zulip Chat](https://iowarp.zulipchat.com)
- **Bug Reports** — [GitHub Issues](https://github.com/iowarp/iowarp/issues)
- **Bug Reports** — [GitHub Issues](https://github.com/iowarp/clio-core/issues)
- **Feature Requests** — [GitHub Discussions](https://github.com/orgs/iowarp/discussions)
- **Email** — grc@illinoistech.edu
2 changes: 1 addition & 1 deletion docs/sdk/context-runtime/2.module_dev_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2407,7 +2407,7 @@ struct SerializableTask : public chi::Task {
```

:::note GPU-Compatible Data Structures
For GPU-compatible modules, HSHM provides shared-memory data structures (`hshm::string`, `hshm::ipc::vector`, `hshm::ipc::ring_buffer`) with cross-platform annotations. See the [Data Structures Guide](/docs/sdk/context-transport-primitives/types/data_structures_guide) for details.
For GPU-compatible modules, HSHM provides shared-memory data structures (`hshm::string`, `hshm::ipc::vector`, `hshm::ipc::ring_buffer`) with cross-platform annotations. See the [Vector Guide](/docs/sdk/context-transport-primitives/types/vector_guide), [Ring Buffer Guide](/docs/sdk/context-transport-primitives/types/ring_buffer_guide), and [String Guide](/docs/sdk/context-transport-primitives/types/string_guide) for details.
:::

### Bulk Transfer Support with ar.bulk
Expand Down
8 changes: 4 additions & 4 deletions docs/sdk/context-runtime/3.module_test_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ A minimal test configuration:

```yaml
networking:
port: 5555
port: 9413

runtime:
num_threads: 4
Expand Down Expand Up @@ -181,7 +181,7 @@ std::string CreateComposeConfig() {
<< " num_threads: 4\n"
<< "\n"
<< "networking:\n"
<< " port: 5555\n"
<< " port: 9413\n"
<< "\n"
<< "compose:\n"
<< "- mod_name: chimaera_bdev\n"
Expand Down Expand Up @@ -405,7 +405,7 @@ ctest -R my_module
rm -f /dev/shm/chimaera_*
```

6. **Kill stale processes on port conflicts**: Tests bind to port 5555. If a previous run left a zombie:
6. **Kill stale processes on port conflicts**: Tests bind to port 9413. If a previous run left a zombie:
```bash
sudo kill -9 $(sudo lsof -t -i :5555) 2>/dev/null
sudo kill -9 $(sudo lsof -t -i :9413) 2>/dev/null
```
Loading