getting started overview

This page is generated from docs/getting-started/index.md. Do not edit it directly; change the repository source and let automation publish the Wiki.

Getting started

Start here to build or run the code, create a small LUND sample, and check its output. A checkout is a local copy of the Git repository. Use a local development checkout for editing and a separate ifarm checkout for production commands.

1. Check dependencies and choose an execution environment.
2. Follow the first-run quickstart through creation, output checks, submission, and job verification.
3. Learn what each output directory means.
4. Create LUND files, choosing the uniform LUND creator or physical LUND converter guide for your input.
5. Submit simulation, then follow its job-verification steps.

The workflow overviews give the reading order within each workflow. Use configuration references when changing a setting, and tutorials when you need complete copyable commands. Contributors should continue with the developer reading path.

If a step fails, use troubleshooting before repeating a command. It explains which failures can leave partial output and when a retry replaces existing files.