Skip to main content

Monte Carlo simulation system for software development effort estimation

Project description

Monte Carlo Project Simulator (mcprojsim)

Stop guessing deadlines. Start simulating them.

Category Link
Package PyPI version Python 3.13+
Documentation Documentation
License License: MIT
Release GitHub release
CI/CD CI Doc build Coverage
Code Quality Code style: black Checked with mypy Linting: flake8
Repo URL GitHub

Overview

mcprojsim is a Monte Carlo simulation tool for agile software project estimation. Rather than producing a single deadline, it models uncertainty across task durations, dependencies, risks, and resource constraints to generate confidence-weighted schedule forecasts.

Use it when you need answers like:

  • What is the realistic completion range — P10 through P99 — for this project?
  • When is there a 50%, 80%, or 90% probability of delivery?
  • Which tasks most frequently land on the critical path?
  • How do specific risks or uncertainty factors shift the final forecast?

Key features

  • Monte Carlo schedule simulation with configurable iterations, P10–P99 confidence percentiles, and reproducible seeds
  • Flexible task estimates: explicit low/expected/high ranges, T-shirt sizes, story points, and multi-category symbolic sizing
  • Two-pass criticality-aware resource scheduling for optimised assignment under resource contention
  • Dependency-only scheduling alongside resource- and calendar-constrained scheduling
  • Risk and uncertainty factor modelling at task and project level
  • Rich analysis: percentile forecasts, critical-path sequences, sensitivity (Tornado) charts, slack, risk impact, staffing recommendations, and delivery-date probability
  • JSON, CSV, and HTML export with configurable distribution chart histogram bins; optional ASCII table output in the CLI
  • Natural-language project generation from plain text via mcprojsim generate
  • MCP server for AI-assistant-driven generation, validation, and simulation workflows
  • Sprint planning with empirical or negative-binomial velocity models, sickness modelling, spillover, and historical sprint data import

Recommended installation

Most users fall into one of two paths:

  • Terminal-first CLI usage: install with pipx.
  • MCP-assisted usage: use the released MCP bundle or the optional MCP package install described in MCP Server Seetup.

For direct terminal-only CLI usage, pipx remains the simplest manual install path:

python3 -m pip install --user pipx
python3 -m pipx ensurepath
pipx install mcprojsim

Then verify the installation:

mcprojsim --help
mcprojsim --version

For the fastest first run, start with Quickstart Guide. For the fuller documentation path after that, use the published User Guide.

[!TIP] A Docker image is available for isolated environments. The accompanying script bin/mcprojsim.sh wraps the container with the same interface as the pipx-installed CLI.

Minimal example

Create a file named project.yaml:

project:
  name: "My Project"
  description: "Sample project for estimation"
  start_date: "2025-11-01"
  confidence_levels: [50, 80, 90]

tasks:
  - id: "task_001"
    name: "Database schema design"
    estimate:
      low: 3
      expected: 5
      high: 10
      unit: "days"
    dependencies: []
    uncertainty_factors:
      team_experience: "high"
      requirements_maturity: "medium"
      technical_complexity: "low"

Validate the file:

mcprojsim validate project.yaml

Run a simulation:

mcprojsim simulate project.yaml --seed 12345 --table

Typical outputs (see the --help for how to specify output) include:

  • *_results.json for full machine-readable output
  • *_results.csv for tabular summaries
  • *_results.html for a browsable report

Documentation map

Use the entry point that matches your goal:

Documentation Link Purpose
Quickstart Guide Fastest terminal-based first run
User Documentation The full documentation site
User Guide The User Guide section
Development Guide contributor and source-checkout workflows

Additional runnable examples can be seen in the Examples section of the user guide or in the project directory examples/.

Example commands

# Generate a project file from a natural language description
mcprojsim generate examples/nl_example.txt -o my_project.yaml

# Validate an input file
mcprojsim validate examples/sample_project.yaml

# Run a reproducible simulation
mcprojsim simulate examples/sample_project.yaml --seed 42

# Use a custom configuration
mcprojsim simulate examples/sample_project.yaml --config examples/sample_config.yaml --seed 42

# Calculate probability of meeting a target date
mcprojsim simulate examples/sample_project.yaml --target-date 2026-06-01

# Format tabular sections for easier reading
mcprojsim simulate examples/sample_project.yaml --table --seed 42

For full CLI coverage, including constrained scheduling, sprint planning, quiet/minimal modes, staffing, and export options, see Running Simulations.

MCP server integration

mcprojsim can run as a Model Context Protocol (MCP) server, letting AI assistants such as GitHub Copilot, Claude Desktop, or any MCP-compatible client generate project files, validate descriptions, and run simulations conversationally.

Install the released MCP bundle from GitHub Releases, or follow the manual setup in MCP Server Setup for installation tradeoffs and natural-language input examples.

Example prompt to install mcprojsim as an MCP server:

Download and install the latest mcprojsim MCP server from GitHub Releases. Follow the README.md for installation instructions.

See the MCP server detailed documentation for examples of using the server.

Citation

If you use this tool in research or project planning, please cite:

@software{mcprojsim,
  title = {Monte Carlo Project Simulator},
  author = {Johan Persson},
  year = {2026},
  url = {https://github.com/johan162/mcprojsim},
  version = {0.14.1}
}

License

MIT License - see LICENSE.

Acknowledgments

Inspired by the work of:

  • Steve McConnell - Software Estimation: Demystifying the Black Art
  • Frederick Brooks - The Mythical Man-Month
  • Douglas Hubbard - How to Measure Anything in Cybersecurity Risk
  • Kahneman, Sibony, Sunstein - Noise: A Flaw in Human Judgment

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcprojsim-0.14.1.tar.gz (146.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcprojsim-0.14.1-py3-none-any.whl (160.4 kB view details)

Uploaded Python 3

File details

Details for the file mcprojsim-0.14.1.tar.gz.

File metadata

  • Download URL: mcprojsim-0.14.1.tar.gz
  • Upload date:
  • Size: 146.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.4 CPython/3.12.3 Linux/6.17.0-1010-azure

File hashes

Hashes for mcprojsim-0.14.1.tar.gz
Algorithm Hash digest
SHA256 ef4d085727eb084023e69faf41e483caa9e5e075d379371c76f9ee44e9c9f3d9
MD5 8fdb49cd7efebee7a0d95d4ffca1bc78
BLAKE2b-256 749f4dfcd7bff48918f5096f54bd437f1951b335346119fd57a6349d96baa6e1

See more details on using hashes here.

File details

Details for the file mcprojsim-0.14.1-py3-none-any.whl.

File metadata

  • Download URL: mcprojsim-0.14.1-py3-none-any.whl
  • Upload date:
  • Size: 160.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.4 CPython/3.12.3 Linux/6.17.0-1010-azure

File hashes

Hashes for mcprojsim-0.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a49fbc0381493411d21c794d7c6bc181fea305d77c6cb59381531527f84b2cd2
MD5 ff892fcdceb87953643ffa5751699ff3
BLAKE2b-256 41db991ef409aa560b60b4bc518238691fc619eb2204dbf14ff4ee6fd5bb5756

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page