Quick-Start

Agilab is a software solution to explore AI for engineering. This quick-start walks you through the minimal steps required to install the framework, open the Streamlit UI, and run one of the sample apps. For architectural context see AGILab Architecture and AGI Core Architecture.

Prerequisites

Python 3.11+ with uv installed (curl -LsSf https://astral.sh/uv/install.sh | sh).
macOS or Linux shell (use WSL2 on Windows until native support lands).
SSH key access to any remote cluster you intend to use.
Optional: PyCharm 2025.2+ to load the bundled run configurations.

LICENSE

New BSD. See License File.

Install Agilab

Bootstrap a workspace (keeps project files and the Streamlit cache in a single folder):
```
mkdir ~/agi-workspace && cd ~/agi-workspace
```
Install the published wheel using uv:
```
uv add agilab
```
Launch the Streamlit UI (runs inside the managed virtual environment):
```
uv run agilab
```
The EXECUTE page opens automatically. Point the sidebar to your apps directory (defaults to ~/agi-workspace/src/agilab/apps).
Run the sample ``mycode`` app either from the UI or the CLI mirror:
```
uv run python src/agilab/examples/mycode/AGI_run_mycode.py
```
This script constructs an AgiEnv, bundles the worker, and executes a full AGI run so you can inspect the generated logs under ~/log/execute/mycode.

Cluster installs

If you want to install on a cluster, the installer must have SSH key access or credentials with permission to deploy workers. See Cluster for the full workflow. pycharm/setup_pycharm.py mirrors Streamlit run configurations to ~/log/execute/<app>/AGI_*.py so that IDE and CLI stay in sync.

Note

On a virgin workspace you do not need to hand-create ~/log/execute/<app> snippets. The installer dispatcher (src/agilab/apps/install.py) calls _seed_example_scripts before kicking off AGI, copying each AGI_*.py helper from src/agilab/examples/<app>/ into ~/log/execute/<app>/ so the first install has runnable mirrors. After that initial bootstrap, the Streamlit EXECUTE page re-generates the snippets on demand according to the form inputs you provide, keeping IDE and CLI flows in sync. Field defaults are read from each app’s app_settings.toml before the form renders, so adjust that file first when you need new baselines.

Next steps

AGILab Architecture – understand how Streamlit, agi_core, agi_env and agi_cluster fit together.
Project Files Structure – explore the repository layout with an annotated tree generated by docs/gen-docs.py.
apps bounded pages – learn how the EXECUTE/EXPLORE/EDIT Streamlit pages mirror the CLI wrappers under tools/run_configs.

Support

Email: focus@thalesgroup.com