Skip to content

Getting Started

Gitronics is designed to be easy to use. The gitronics command-line interface provides useful operations for building and migrating models but the most important part of the workflow is the concept of organizing your model into modular components and track them with Git.

This Getting Started guide will help you understand the Gitronics workflow and get your first model built. It is highly recommended that you read the whole guide before starting to use Gitronics, it takes only a few minutes. The guide is organized into the following sections:

  1. Concepts — basic concepts and keywords of Gitronics.
  2. Project Structure — how to organize your model into a Gitronics project.
  3. File Types — the different types of files that can be part of a Gitronics project.
  4. Configuration File — how to define and use configuration files in Gitronics.
  5. Building a Model — how to assemble an MCNP input from a Gitronics project.
  6. Card ID Numbers — how to avoid duplicated card IDs in your project.
  7. Migrating an Existing Model — how to convert a monolithic MCNP input into a Gitronics project layout.
  8. Starting a New Project — how to create a fresh project structure manually.
  9. Assessments — how to manage assessment-specific changes for your project.

Once you have read the guide, you can learn how to install Gitronics, learn about the best practices for managing your project, read the API reference and checkout examples of Gitronics projects: