Guide users through setting up and running scientific simulations with FermiLink after `pip install fermilink` and `fermilink init`. Covers package installation, provider setup, execution modes, HPC configuration, and workflow selection.
Use this skill when the user asks how to use FermiLink for scientific
simulations, needs help choosing an execution mode, or wants guidance on
setting up their environment after running pip install fermilink and
fermilink init.
Read this first:
references/simulation-walkthrough.mdThe user has already completed:
pip install fermilinkfermilink init in a clean project directoryThey now have a local workspace with FermiLink's AGENTS.md, skills/,
and CLAUDE.md/GEMINI.md aliases provisioned. They are inside this
initialized directory talking to a local agent (Codex, Claude Code, Gemini
CLI, a desktop app, or a VS Code extension).
Before suggesting any simulation command, confirm these are in place:
codex login, claude,
or gemini).fermilink install <package_id>).Help the user pick the right mode. Match the simulation scope to the right FermiLink mode:
fermilink execfermilink chatfermilink loopfermilink reproducefermilink researchfermilink start (web UI)fermilink gateway (Telegram bot)Prefer concrete commands over conceptual explanations. Show the exact command, expected output paths, and next steps.
Surface HPC options when relevant. If the user mentions clusters, SLURM, multi-node, or large-scale runs, guide them to:
fermilink hpc for default HPC profile setup.--hpc-profile <json> flag on exec/loop/research/reproduce.Point to package discovery. If the user is unsure which package to install, suggest:
fermilink avail <keyword> to search the curated catalog.fermilink list to see what is already installed locally.The user needs at least one agent provider CLI installed and logged in.
# Codex (OpenAI)
npm i -g @openai/codex # or: brew install codex
codex login
# Claude (Anthropic)
# install from official distribution, then authenticate
# Gemini (Google)
# install from official distribution, then authenticate
Then set FermiLink's default provider:
fermilink agent codex # or claude, gemini, deepseek
# search for available packages
fermilink avail <keyword>
# install a package knowledge base
fermilink install <package_id> --activate
# install multiple packages
fermilink install ase meep qutip
fermilink activate meep
Pick the mode that matches the job scope:
# one-shot execution
fermilink exec "simulate X and plot Y"
fermilink exec goal.md
# interactive multi-turn chat
fermilink chat
# autonomous iterative loop (supports PID/SLURM job polling)
fermilink loop goal.md
fermilink loop --max-iterations 10 --max-wait-seconds 3600 goal.md
# full-paper reproduction
fermilink reproduce paper.tex --plan-only # review plan first
fermilink reproduce paper.tex # execute
# idea-driven research
fermilink research idea.md --plan-only # review plan first
fermilink research idea.md # execute
# interactive HPC profile setup
fermilink hpc
# use explicit HPC profile per run
fermilink loop goal.md --hpc-profile hpc_profile.json
# web UI (ChatGPT-like browser experience)
fermilink start
# Telegram bot for remote control
export FERMILINK_GATEWAY_TELEGRAM_TOKEN="<token>"
export FERMILINK_GATEWAY_TELEGRAM_ALLOW_FROM="<user-id>"
fermilink gateway
fermilink avail <keyword> and
describe what the top results cover. If the user's domain is not in the
curated catalog, suggest fermilink compile to build a custom knowledge
base from a local package.fermilink exec goal.md.fermilink dependencies <main_pkg> --package <aux_pkg> to expose an
auxiliary package alongside the main one during execution.fermilink agent --json
shows provider/model/sandbox state. fermilink list shows installed
packages. fermilink (bare) gives a full status overview.projects/memory.md across modes. It includes short-term plan/progress
and long-term durable outcomes (file maps, simulation history, key
results). Memory persists across exec/loop/research/reproduce
runs in the same workspace.fermilink clean removes
managed workspace artifacts. Then fermilink init to re-bootstrap.--hpc-profile.docs/source/usage.rst, docs/source/installation.rst,
docs/source/scientific_packages.rst, etc.