Metadata-Version: 2.4
Name: cfast-mcp
Version: 0.1.0
Summary: MCP server for CFAST (Fire and Smoke Transport), built on top of PyCFAST.
Project-URL: Homepage, https://github.com/bewygs/cfast-mcp
Project-URL: Repository, https://github.com/bewygs/cfast-mcp
Project-URL: Issues, https://github.com/bewygs/cfast-mcp/issues
Author-email: WYGAS Benoît <97663334+bewygs@users.noreply.github.com>
Maintainer-email: WYGAS Benoît <97663334+bewygs@users.noreply.github.com>
License: MIT License
        
        Copyright (c) 2025 Benoît WYGAS.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: cfast,engineering,fire,fire-safety,mcp,modeling,python,server,simulation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Requires-Dist: mcp[cli]>=1.27.0
Requires-Dist: pycfast>=0.2.1
Provides-Extra: dev
Requires-Dist: coverage>=7.13.4; extra == 'dev'
Requires-Dist: mypy>=1.19.1; extra == 'dev'
Requires-Dist: pandas-stubs>=2.3.3.260113; extra == 'dev'
Requires-Dist: pre-commit>=4.3.0; extra == 'dev'
Requires-Dist: pytest-cov>=7.0.0; extra == 'dev'
Requires-Dist: pytest>=8.4.2; extra == 'dev'
Requires-Dist: ruff>=0.15.1; extra == 'dev'
Description-Content-Type: text/markdown

# CFAST MCP

An MCP server that lets an LLM build, inspect, run, and analyze [CFAST](https://pages.nist.gov/cfast/) (Consolidated Fire and Smoke Transport, NIST) fire models step by step, via [PyCFAST](https://github.com/bewygs/pycfast).

It exposes tools to add/update compartments, materials, vents, fires, devices, and surface connections, then run the simulation and read results as bounded summaries.

## Installation

Requires **Python 3.10+** and **CFAST 7.7.0+**.

### CFAST

Download and install CFAST from the [NIST CFAST website](https://pages.nist.gov/cfast/) or the [CFAST GitHub repository](https://github.com/firemodels/cfast), and ensure `cfast` is on your `PATH`. If it's installed elsewhere, set the `CFAST` environment variable to the executable path:

```bash
export CFAST="/path/to/your/cfast/executable"
```

### Server

```bash
pip install cfast-mcp
```

## Usage

Add the server to your MCP client configuration:

```json
{
  "mcpServers": {
    "cfast": {
      "command": "cfast-mcp",
      "env": { "CFAST": "/path/to/your/cfast/executable" }
    }
  }
}
```

Or run it directly:

```bash
cfast-mcp
```

## Development

```bash
git clone https://github.com/bewygs/cfast-mcp.git
cd cfast-mcp
uv sync --extra dev          # install dev dependencies
uv run pytest                # run tests
uv run ruff check --fix .    # lint
uv run ruff format .         # format
uv run mypy src/              # type-check
```

See [CLAUDE.md](CLAUDE.md) for architecture and contribution details.
