How-To Guides

Task-oriented guides for common Biosimulant workflows. Each guide answers a specific question and walks you through the steps to accomplish it.

New to Biosimulant? Start with the Library Quickstart for installation and your first simulation. Come back here when you know the basics and want to do something specific.

Core Library

Create a BioModule: Build a custom simulation component from scratch.
Use a BioModule: Import, instantiate, and inspect an existing module.
Use a BioWorld: Orchestrate modules, wire them, and run simulations.
Write a model.yaml: Define your module’s manifest for packaging, metadata, and reuse.
Write a lab.yaml: Define a composed simulation with multiple modules.
Test a BioModule: Unit and integration testing patterns for modules.

Composition & Running

Compose Nested Labs: Build hierarchical simulations with child labs.
Run Parameter Sweeps: Batch runs with varying parameters and result comparison.
Wrap an External Simulator: Turn SBML, NeuroML, or other simulators into BioModules.
Add an ONNX Model: Integrate machine learning models into simulations.

Visualization & UI

Add a SimUI Interface: Create an interactive web UI for your simulation.
Custom Visualizations: Implement timeseries, bar, table, and image visualizations.

Package & Publish: Build portable package files for validation, sharing, and local workflows.
Create a Domain Pack: Build a reusable collection of related BioModules.

Desktop & CLI

CLI: Install, auth, and script the canonical biosimulant CLI.
CLI Command Reference: Full raw command catalog.
Build a Desktop Plugin: Extend the desktop app with custom tools or agents.

Web Quickstart Create a BioModule