Documentation

Everything you need to know to get started with OptiForge and build powerful optimization solutions for industrial applications.

Quick Start Guide

Get up and running with OptiForge in minutes. Follow these steps to transform your optimization problems into QUBO solutions.

1. Sign Up

Create your account and get API access to start optimizing.

2. Build Model

Create your system model with elements and connections.

3. Define Rules

Specify optimization constraints and objectives.

4. Optimize

Run quantum, hybrid, or classical solvers.

System Requirements

Browser Requirements

  • Modern web browser (Chrome, Firefox, Safari, Edge)
  • JavaScript enabled
  • Internet connection

API Access

  • Valid API key for solver access
  • HTTPS support for secure communication
  • REST API compatible client
Getting Started

Welcome to OptiForge

OptiForge is a cloud-based platform for transforming industrial optimization problems into efficient QUBO (Quadratic Unconstrained Binary Optimization) formulations.

Core Concepts

System Models

Represent your industrial systems with interconnected elements and resources.

QUBO Formulation

Automatic translation of constraints into quantum-optimizable binary quadratic forms.

Solver Integration

Seamless access to quantum, hybrid, and classical optimization solvers.

API Reference

REST API Endpoints

Authentication

All API requests require authentication via Bearer token:

Authorization: Bearer YOUR_API_KEY

POST /v1/models

Create a new optimization model.

{
  "name": "Supply Chain Model",
  "elements": [
    {"id": "warehouse1", "type": "storage", "capacity": 1000},
    {"id": "truck1", "type": "transport", "capacity": 500}
  ],
  "connections": [
    {"from": "warehouse1", "to": "truck1", "cost": 10}
  ]
}

POST /v1/optimize

Run optimization on a compiled QUBO model.

{
  "qubo": {
    "variables": ["x1", "x2", "x3"],
    "quadratic_terms": [{"i": 0, "j": 1, "coefficient": 2.0}],
    "linear_terms": [{"i": 0, "coefficient": -1.0}]
  },
  "solver": "quantum",
  "timeout": 300
}

GET /v1/results/{job_id}

Retrieve optimization results.

{
  "status": "completed",
  "solution": {"x1": 1, "x2": 0, "x3": 1},
  "energy": -2.5,
  "execution_time": 45.2
}
Model Building Guide

Creating System Models

Elements

Elements represent components in your system:

  • Storage: Warehouses, buffers, inventories
  • Transport: Vehicles, pipelines, conveyors
  • Process: Machines, workers, production lines
  • Resource: Raw materials, energy, time slots

Connections

Connections define relationships between elements:

{
  "connections": [
    {
      "from": "warehouse_a",
      "to": "production_line_1",
      "type": "material_flow",
      "capacity": 100,
      "cost": 5.0
    }
  ]
}

Rules and Constraints

Define optimization objectives and constraints:

{
  "rules": [
    {
      "type": "minimize_cost",
      "expression": "sum(connection.cost * flow)"
    },
    {
      "type": "capacity_constraint",
      "expression": "flow <= connection.capacity"
    }
  ]
}
Solver Integration

Available Solvers

Quantum Solvers

  • D-Wave Quantum Annealer
  • IBM Quantum Systems
  • Rigetti Quantum Cloud

Classical Solvers

  • Gurobi Optimizer
  • CPLEX
  • SCIP

Solver Configuration

{
  "solver_config": {
    "type": "dwave",
    "parameters": {
      "num_reads": 1000,
      "annealing_time": 20,
      "chain_strength": 1.5
    }
  }
}
Best Practices

Optimization Best Practices

Model Design

  • Start with small, representative models
  • Use hierarchical decomposition for complex systems
  • Validate constraints before optimization
  • Consider problem symmetry to reduce solution space

Performance Optimization

  • Preprocess data to reduce problem size
  • Use appropriate solver for problem characteristics
  • Implement timeout limits for long-running jobs
  • Cache frequently used model components

Security Considerations

  • Store API keys securely
  • Use HTTPS for all API communications
  • Limit API key permissions to required operations
  • Regularly rotate authentication credentials

Ready to Start Optimizing?

Join the growing community of industrial optimization experts using OptiForge to solve complex problems with quantum computing.

Get Started Now