json2ciw v0.10.0
  • User Guide
  • Reference
  • Changelog

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 

Codex / OpenCode

Tell the agent:
Fetch the skill file at <site-url>/skill.md and follow the instructions.

Manual — download the skill file:

curl -O <site-url>/skill.md

Or browse the SKILL.md file.

SKILL.md

---
name: json2ciw
description: >
  A python package to convert JSON file to 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 file to working Ciw DES models

## Installation

```bash
pip install json2ciw
```

## API overview

### Classes

Core classes

- `CiwConverter`

### Functions

Public functions

- `multiple_replications`: Run multiple replications of a Ciw simulation and collect performance metrics
- `summarise_results`: Aggregate replication results and transpose so metrics are rows
- `tidy_to_wide_format`: Return replication results in wide format:
- `create_user_filtered_hist`: Create a Plotly histogram with a dropdown that lets the user
- `render_simulation_app`: Main function to render the simulation UI and execute the model

## Resources

- [llms.txt](llms.txt) — Indexed API reference for LLMs
- [llms-full.txt](llms-full.txt) — Comprehensive documentation for LLMs

Developed by Thomas Monks and Amy Heather.
Site created with Great Docs.