# ModelScript

> Open-core computable digital thread for polyglot engineering and simulation. Imports 66 simulation and CAE formats, links them to requirements, solves DAEs/ODEs via a WebAssembly linear-memory arena, coordinates cross-domain co-simulation, and exports FMI 2.0/3.0 FMUs.

## Quick Links
- [Official Website](https://modelscript.org/)
- [GitHub Repository](https://github.com/modelscript/modelscript)
- [Pricing & Commercial Licensing](https://modelscript.org/pricing): Open-Core (AGPLv3 Community Edition), Enterprise Intranet Appliance (`ee/`), and Commercial OEM SDK licensing.
- [Trademark Policy](https://modelscript.org/trademark): Official trademark and brand usage guidelines for ModelScript and Ansatz.
- [Full Documentation (Single File)](https://modelscript.org/llms-full.txt)

## Guides & Learning
- [Introduction](https://modelscript.org/guide/introduction): Architectural vision, computable digital thread, and key differentiators.
- [Installation](https://modelscript.org/guide/installation): CLI installation, VS Code extension, and local setup.
- [Getting Started](https://modelscript.org/guide/getting-started): First steps, project scaffolding, and simulation execution.
- [AI Agents & MCP Workflows](https://modelscript.org/guide/ai-agents): Closed-loop AI engineering workflows and Model Context Protocol setup.
- [CI/CD & GitHub Actions](https://modelscript.org/guide/ci-cd): Automated linting, formal verification, and SARIF code scanning.
- [Embedding ModelScript](https://modelscript.org/guide/embedding): Headless programmatic usage in Node.js, browsers, and WebAssembly.
- [Administration](https://modelscript.org/guide/administration): Enterprise deployment, licensing, and security disclosures.

## Ansatz Platform (`ansatz.social`)
- [Ansatz Platform Overview](https://modelscript.org/ansatz/overview): Collaborative systems engineering cloud, package registry, literature hub, and cloud HPC dispatcher.
- [Workflow Replacement Guide](https://modelscript.org/ansatz/workflow-replacement): Displacing legacy first-party engineering monoliths (Dymola, Cameo, Simulink, PSCAD, OLGA) through a 5-stage wedge.
- [ActivityPub Federation](https://modelscript.org/ansatz/federation): W3C ActivityPub S2S federation, WebFinger, and peer verification.
- [Package Registry](https://modelscript.org/ansatz/package-registry): Content-addressable package registry with Ed25519 signatures and multi-lens manifests.
- [Cloud HPC Simulation](https://modelscript.org/ansatz/cloud-hpc): Slurm HPC offload, WebGPU batched sweeps, and compute credit billing.
- [Self-Hosting Guide](https://modelscript.org/ansatz/self-hosting): Docker Compose deployment profiles, Cloudflare Zero Trust tunnels, and hot SQLite backups.

## Compiler Architecture & WebAssembly Runtime
- [Architecture Overview](https://modelscript.org/architecture/overview): Salsa memoization, WASM linear memory DAE arena, and lowering pipeline.
- [Monorepo & Taxonomy](https://modelscript.org/architecture/monorepo): Workspace organization, package boundaries, and dependency taxonomy.
- [DAE Arena](https://modelscript.org/architecture/dae-arena): Struct-of-arrays linear memory DAE container for zero-overhead symbolic transformations.
- [GLR Parser](https://modelscript.org/architecture/glr-parser): High-performance native WebAssembly generalized LR parser generator.
- [Salsa Query Engine](https://modelscript.org/architecture/salsa-queries): Incremental memoization, dependency tracking, and Salsa cache backdating.
- [Simulation Solvers](https://modelscript.org/architecture/simulation-solvers): SUNDIALS CVODE/IDA, BDF, Runge-Kutta, and WebGPU batched solver.
- [Triple Graph Grammars](https://modelscript.org/architecture/tgg): Bidirectional schema synchronization and multi-language transformation.
- [Theory Coordinator](https://modelscript.org/architecture/theory-coordinator): Cross-domain physical theory unification and ontology coordination.
- [HIL & WASM Runtime](https://modelscript.org/architecture/hil-wasm-runtime): Hardware-in-the-loop and headless WebAssembly execution.

## Algorithms & Solvers Catalog
- [Algorithms Catalog Overview](https://modelscript.org/algorithms/overview): Catalog of 16 symbolic and numerical algorithms.
- [BLT Partitioning](https://modelscript.org/algorithms/blt): Block Lower Triangular decomposition, bipartite matching, and Tarjan SCC.
- [Pantelides Index Reduction](https://modelscript.org/algorithms/pantelides): Structural index reduction for high-index DAEs to index-1 form.
- [Algebraic Loop Tearing](https://modelscript.org/algorithms/tearing): Cellier tearing and minimal residual selection for nonlinear systems.
- [Numerical Solvers (ODE/DAE)](https://modelscript.org/algorithms/solvers-ode-dae): Adaptive step-size numerical integrators and stiff solvers.
- [Automatic Differentiation](https://modelscript.org/algorithms/autodiff): Forward and reverse mode algorithmic differentiation on arena expressions.
- [Optimization & Optimal Control](https://modelscript.org/algorithms/optimization): Collocation, parameter estimation, and nonlinear programming.
- [Surrogates & Linear Algebra](https://modelscript.org/algorithms/surrogates-linear-algebra): Dynamic mode decomposition, POD, and neural surrogates.
- [Connector Balancing](https://modelscript.org/algorithms/connector-balancing): Kirchhoff current law and flow variable balance equations.
- [Physical Theory Coordination](https://modelscript.org/algorithms/theory-coordinator): Multi-physics conservation laws and constitutive relations.
- [Graph Rewriting & E-Graphs](https://modelscript.org/algorithms/graph-rewriting): E-graph rewriting and term normalization.
- [Formal Verification & CHC](https://modelscript.org/algorithms/verification-chc): Constrained Horn Clauses and formal contract verification.
- [Abstract Interpretation](https://modelscript.org/algorithms/abstract-interpretation): Interval arithmetic and sign domain safety analysis.
- [SDP & BVP for CAD](https://modelscript.org/algorithms/sdp-bvp-cad): Boundary value problem solving on CSG and boundary representation geometry.
- [Diagram Layout](https://modelscript.org/algorithms/diagram-layout): Orthogonal routing and hierarchical port placement.
- [Linear Memory Structures](https://modelscript.org/algorithms/linear-memory-structures): Zero-allocation arena buffers and offset-based pointers.

## Command-Line Interface (`msx`)
- [CLI Overview](https://modelscript.org/cli/overview): Overview of the `msx` binary, global flags, and architecture.
- [Commands Reference](https://modelscript.org/cli/commands): Comprehensive reference for all 104 CLI commands and subcommands.

## Polyglot Languages (66 Formats)
- [Polyglot Overview & Capability Matrix](https://modelscript.org/languages/overview): Cross-language capability matrix across all 66 formats.
- [Modelica (.mo) [stable]](https://modelscript.org/languages/modelica): Acausal multi-domain physics.
- [SysML v2 / KerML (.sysml) [stable]](https://modelscript.org/languages/sysml2): Systems architecture & requirements.
- [ReqIF (.reqif) [stable]](https://modelscript.org/languages/reqif): Requirements interchange & contract entailment.
- [NIST OSCAL (.oscal.json) [beta]](https://modelscript.org/languages/oscal): Cyber-physical security controls & SP 800-53 assessment.
- [SSP (.ssp) [stable]](https://modelscript.org/languages/ssp): FMU system structure & parameterization.
- [OWL2 (.owl) [stable]](https://modelscript.org/languages/owl2): Ontologies & description-logic reasoning.
- [STEP (ISO 10303) (.step) [stable]](https://modelscript.org/languages/step): B-Rep CAD assemblies & AP242 PMI.
- [QIF (ISO 23952) (.qif) [beta]](https://modelscript.org/languages/qif): ASME Y14.5 / ISO 1101 GD&T metrology & SPC capability.
- [OpenSCAD (.scad) [stable]](https://modelscript.org/languages/scad): Parametric constructive solid geometry.
- [CFD (SU2 / OpenFOAM) (.su2) [preview]](https://modelscript.org/languages/cfd): Computational fluid dynamics meshes.
- [FEA (CalculiX / Abaqus / NASTRAN) (.inp) [preview]](https://modelscript.org/languages/fea): Finite-element structural analysis.
- [OpenUSD (.usd / .usda / .usdz) [preview]](https://modelscript.org/languages/usd): Universal Scene Description 3D stages & UsdPhysics digital twins.
- [CSV (.csv) [stable]](https://modelscript.org/languages/csv): Time-series & sensor logs.
- [C (.c) [beta]](https://modelscript.org/languages/c): Numerical & embedded C integration.
- [Fortran (.f90) [preview]](https://modelscript.org/languages/fortran): Legacy scientific subroutines.
- [JSBSim (.xml) [preview]](https://modelscript.org/languages/jsbsim): 6-DOF flight dynamics.
- [NASA ROCETS (.roc) [beta]](https://modelscript.org/languages/rocets): Liquid rocket engine transients.
- [CCSDS (.xtce) [beta]](https://modelscript.org/languages/ccsds): Astrodynamics & spacecraft telemetry.
- [EASY5 (.ez5) [beta]](https://modelscript.org/languages/easy5): Dynamic simulation & linear control.
- [AUTOSAR (.arxml) [beta]](https://modelscript.org/languages/autosar): Classic & Adaptive software architecture.
- [MATLAB Simulink (.slx) [beta]](https://modelscript.org/languages/simulink): Block diagrams & control systems.
- [GT-SUITE (.gtm) [beta]](https://modelscript.org/languages/gtsuite): Engine, powertrain & thermal flow.
- [ASAM OpenDRIVE (.xodr) [beta]](https://modelscript.org/languages/opendrive): Road network geometry.
- [ASAM OpenSCENARIO (.xosc) [preview]](https://modelscript.org/languages/openscenario): Driving scenarios & RSS safety margins.
- [GENSYS (.calc) [stable]](https://modelscript.org/languages/gensys): Railway vehicle dynamics & track.
- [SIMPACK (.spck) [beta]](https://modelscript.org/languages/simpack): Spatial multibody dynamics.
- [PSCAD / EMTDC (.pscx) [stable]](https://modelscript.org/languages/pscad): Electromagnetic transients (EMT).
- [PSS/E (.raw) [preview]](https://modelscript.org/languages/psse): Transmission power flow.
- [OpenDSS (.dss) [preview]](https://modelscript.org/languages/opendss): Unbalanced distribution & DER hosting.
- [OLGA (.genkey) [stable]](https://modelscript.org/languages/olga): Transient multiphase flow assurance.
- [PipelineStudio (.lps) [stable]](https://modelscript.org/languages/lps): Gas & liquid pipeline hydraulics.
- [ECLIPSE (.data) [preview]](https://modelscript.org/languages/eclipse): Reservoir engineering.
- [RELAP5-3D (.inp) [preview]](https://modelscript.org/languages/relap5): Reactor thermal-hydraulics & kinetics.
- [SIMA / SIMO / RIFLEX (.sima) [preview]](https://modelscript.org/languages/sima): Marine operations & riser dynamics.
- [SPICE (.cir) [stable]](https://modelscript.org/languages/spice): Analog circuit simulation.
- [Verilog-A / AMS (.va) [beta]](https://modelscript.org/languages/verilog-a): Analog compact device models.
- [IBIS (.ibs) [preview]](https://modelscript.org/languages/ibis): I/O buffer behavioral models.
- [Touchstone (.sNp) [preview]](https://modelscript.org/languages/touchstone): RF & signal-integrity S-parameters.
- [URDF / Xacro (.urdf) [beta]](https://modelscript.org/languages/urdf): Robot kinematics & dynamics.
- [PLCopen / IEC 61131-3 (.st) [beta]](https://modelscript.org/languages/plcopen): PLC control software.
- [AutomationML (IEC 62714) (.aml) [beta]](https://modelscript.org/languages/automationml): CAEX mechatronic plant hierarchy & virtual commissioning.
- [MSC Adams (.adm) [beta]](https://modelscript.org/languages/adams): Mechanical system dynamics.
- [EnergyPlus (.idf) [beta]](https://modelscript.org/languages/energyplus): Building energy & HVAC.
- [EPANET (.inp) [beta]](https://modelscript.org/languages/epanet): Pressurized water distribution.
- [EPA SWMM (.inp) [preview]](https://modelscript.org/languages/swmm): Stormwater & urban drainage.
- [Aspen Plus / HYSYS (.bkp) [preview]](https://modelscript.org/languages/aspen): Chemical process flowsheets.
- [gPROMS / PML (.gproms) [preview]](https://modelscript.org/languages/gproms): Equation-oriented dynamic process & distributed PDEs.
- [Cantera (.yaml) [preview]](https://modelscript.org/languages/cantera): Gas-phase chemical kinetics & NASA-7 thermochemistry.
- [PHREEQC (.pqi) [preview]](https://modelscript.org/languages/phreeqc): Aqueous geochemistry, speciation & mineral saturation.
- [SMILES / SDF (.smi) [preview]](https://modelscript.org/languages/smiles): Molecular graph parsing & Joback property estimation.
- [SBML (.sbml) [preview]](https://modelscript.org/languages/sbml): Biochemical reaction networks.
- [Antimony (.ant) [preview]](https://modelscript.org/languages/antimony): Modular human-readable systems biology models.
- [BioNetGen (BNGL) (.bngl) [preview]](https://modelscript.org/languages/bngl): Rule-based multiprotein signaling & reaction expansion.
- [SBOL3 (.sbol) [preview]](https://modelscript.org/languages/sbol): Synthetic biology genetic circuits & Hill kinetics.
- [SED-ML (.sedml) [preview]](https://modelscript.org/languages/sedml): COMBINE reproducible simulation experiment protocols.
- [NMTRAN (NONMEM) (.ctl) [preview]](https://modelscript.org/languages/nmtran): Clinical PK/PD compartmental dosing & exposure.
- [PDB / mmCIF (.pdb) [preview]](https://modelscript.org/languages/pdb): 3D protein structures, Ramachandran & GNM dynamics.
- [GenBank / FASTA (.gb) [preview]](https://modelscript.org/languages/genbank): Annotated nucleotide sequences, ORFs & restriction maps.
- [CellML (.cellml) [beta]](https://modelscript.org/languages/cellml): Cellular electrophysiology & Physiome ODE models.
- [OpenSim (.osim) [beta]](https://modelscript.org/languages/opensim): Musculoskeletal multibody & Hill-type muscle dynamics.
- [FEBio / SOFA (.feb) [beta]](https://modelscript.org/languages/febio): Hyperelastic soft-tissue biomechanics & surgical scenes.
- [DICOM-RT (.rtplan) [beta]](https://modelscript.org/languages/dicom-rt): Clinical radiotherapy plans, DVH metrics & BED/EQD2.
- [TOPAS / GATE (.topas) [beta]](https://modelscript.org/languages/topas): Proton & hadrontherapy nozzles and Bortfeld Bragg peaks.
- [NIfTI / NRRD (.nii) [beta]](https://modelscript.org/languages/nifti): Volumetric medical imaging, RAS affines & iso-surfacing.
- [3MF Medical (.3mf) [beta]](https://modelscript.org/languages/three-mf): Patient-specific 3D-printed cutting guides & implants.
- [OpenIGTLink / PLUS (.igtl) [beta]](https://modelscript.org/languages/igtl): Image-guided surgical tracking, pivot calibration & TRE.

## Engineering Industries (12 Sectors)
- [Industries Overview](https://modelscript.org/industries): Multi-domain solutions across 12 engineering sectors.
- [Aerospace & Aviation](https://modelscript.org/industries/aerospace): Flight dynamics, propulsion & mission telemetry (SysML v2 / KerML, ReqIF, NIST OSCAL 1.1).
- [Automotive & Mobility](https://modelscript.org/industries/automotive): AUTOSAR, powertrain & autonomous-driving scenarios (AUTOSAR Classic & Adaptive, ASAM OpenDRIVE, ASAM OpenSCENARIO).
- [Rail](https://modelscript.org/industries/rail): Vehicle dynamics, track geometry & EN 14363 (EN 14363, UIC 518, STEP AP242).
- [Marine & Offshore](https://modelscript.org/industries/marine): Marine operations, risers & mooring (DNV-OS-E301, DNV-ST-0119, FMI 2.0 / 3.0).
- [Power Systems & Grid](https://modelscript.org/industries/power-systems): EMT, power flow & grid-code compliance (IEEE 2800-2022, NERC PRC-029-1, NIST OSCAL 1.1 (NERC CIP)).
- [Oil, Gas & Subsurface](https://modelscript.org/industries/oil-gas): Flow assurance, pipelines & reservoirs (ISO 20765-1, ISO 20765-2, USGS PHREEQC).
- [Nuclear](https://modelscript.org/industries/nuclear): Reactor thermal-hydraulics & point kinetics (RELAP5-3D input decks, SysML v2, ReqIF).
- [Buildings & Civil Infrastructure](https://modelscript.org/industries/buildings): Building energy, water & stormwater networks (EnergyPlus IDF / epJSON, EPANET INP, SWMM 5.x).
- [Electronics & Semiconductors](https://modelscript.org/industries/electronics): SPICE, compact models, IBIS & S-parameters (IEEE 1857 Verilog-A / AMS, IBIS, Touchstone 1.0 / 2.0).
- [Robotics & Industrial Automation](https://modelscript.org/industries/robotics): URDF kinematics, AutomationML, PLCs & mechanisms (IEC 61131-3 / PLCopen XML, IEC 62714 AutomationML (CAEX), URDF / Xacro).
- [Chemical & Process](https://modelscript.org/industries/process): Flowsheets, kinetics, geochemistry & molecular graphs (Aspen Plus / HYSYS inputs, gPROMS PML, Cantera YAML / NASA-7).
- [Life Sciences, Healthcare & Medical](https://modelscript.org/industries/life-sciences): Systems biology, pharmacometrics, radiotherapy & surgical CAS (SBML L2/L3 & SED-ML, SBOL3 & GenBank, NONMEM NMTRAN).

## Reference & Tooling
- [Linter Rules Catalog](https://modelscript.org/reference/linter-rules): Directory of 1018 diagnostics across 65 engineering languages.
- [Export Formats](https://modelscript.org/reference/export-formats): Exporting to FMI 2.0/3.0 FMUs, SSP, STEP, CSV, and C code.
- [MCP & IDE Integration](https://modelscript.org/reference/mcp-and-ide): Model Context Protocol server for AI coding agents and VS Code integration.
- [Radiology & Surgical CAS](https://modelscript.org/reference/radiology-and-surgery): Radiation oncology, medical imaging, and computer-assisted surgery suite.