Skills

A skill is a package of structured files that teaches an AI coding agent how to work with a specific tool or framework. The skill below was generated by Great Docs from this project’s documentation. Install it in your agent and it will be able to run commands, edit configuration, write content, and troubleshoot problems without step-by-step guidance from you.

Any agent — install with npx:

npx skills add https://sim-agent.github.io/json2ciw/

Codex / OpenCode

Tell the agent:
Fetch the skill file at https://sim-agent.github.io/json2ciw/skill.md and follow the instructions.

Manual — download the skill file:

curl -O https://sim-agent.github.io/json2ciw/skill.md

Or browse the SKILL.md file.

SKILL.md

---
name: json2ciw
description: >
  A python package to convert JSON files into working Ciw DES models. Use when writing Python code that uses the json2ciw package.
license: MIT
compatibility: Requires Python >=3.11.
---

# json2ciw

A python package to convert JSON files into working Ciw DES models

## Installation

```bash
pip install json2ciw
```

## API overview

### Classes

Core classes

- `CiwConverter`: Convert a process model into Ciw network parameters
- `ProcessModel`: Define a validated queueing network process model

### ProcessModel Methods

Methods for the ProcessModel class

- `ProcessModel.validate_transition_rows`
- `ProcessModel.to_mermaid`
- `ProcessModel.display_diagram`
- `ProcessModel.save_diagram`
- `ProcessModel.get_distributions_df`
- `ProcessModel.get_routing_matrix_df`
- `ProcessModel.get_resources_df`

### Functions

Public functions

- `load_call_centre_model`: Load the call centre model specification
- `load_jackson_network_model`: Load the classic open jackson network model specification
- `load_mm1_renege_model`: Load the M/M/1 reneging model specification
- `load_model_file`: Load a model specification from a JSON file
- `load_renege_call_model`: Load the reneging call centre model specification
- `load_six_node_ucc_model`: Load the six-node urgent care model specification
- `load_three_node_network_model`: Load the three-node network model specification
- `multiple_replications`: Run multiple simulation replications and collect node metrics
- `create_user_filtered_hist`: Create an interactive histogram for selected result columns
- `summarise_results`: Summarise replication results by activity
- `tidy_to_wide_format`: Convert tidy replication results to wide format

## Resources

- [Full documentation](https://sim-agent.github.io/json2ciw/)
- [llms.txt](llms.txt) — Indexed API reference for LLMs
- [llms-full.txt](llms-full.txt) — Comprehensive documentation for LLMs