GitHub

Getting Started

This quick start shows the minimal steps to install the core JCGE packages and run a reference model. For full workflows and modeling guidance, see the Guides.

Prerequisites

  • Julia 1.9+ installed and on your PATH.
  • A clean project environment (recommended).

Install

Create or activate a project before adding packages:

import Pkg
Pkg.activate(".")

Then add the core packages:

import Pkg
Pkg.add([
    "JCGECore",
    "JCGEBlocks",
    "JCGERuntime",
    "JCGECalibrate",
    "JCGEOutput",
])

Run a reference model

using JCGEExamples
result = JCGEExamples.StandardCGE.solve()

Inspect results

The returned result contains the solved model and output artifacts. Typical next steps include inspecting reports and exporting tables via JCGEOutput.

Solver note

For MCP models, PATHSolver is required. See the Imports guide for license setup.

Agent interface

If you want to use JCGE through an MCP-compatible AI assistant, add JCGEAgentInterface to the same Julia environment:

import Pkg
Pkg.add("JCGEAgentInterface")

The AI Agent Interface guide explains the registered MCP server, Docker image, and model-development services.

Next steps