Project-Rat-Extras Documentation

Project-Rat-Extras (or PRE) is a GitLab group offering utilities for the Project-Rat GitLab group, a suite of open-source C++ libraries for 3D magnetostatic simulations and magnet design. See Rat-Docs for more information.

This repository serves as a global documentation portal for the whole group in order to centralize information and knowledge in the form of a Sphinx static website to be hosted on GitLab pages.

Note

This project is under active development.

Overview

Documentation covers repositories of this GitLab group:

• Docs: general documentation

• Rat-vcpkg: vcpkg ports and registry for Rat

• Rat-Containers: container definitions and helpers for Rat

• pyRat: Python bindings for Rat

The overall table of content is available here:

CONTENTS

• Introduction
  • About the group
  • Development plan
  • Projects coverage
  • License
  • Credits
• Docs
  • Structure
    • The docs/docs subdirectory
  • Setup, build and use
    • Setup
    • Build
    • Use
    • Deploy
  • Relations to other projects
  • Meral
    • Admonitions
• Rat-vcpkg
  • Setup
    • Install a compilation toolchain
    • Install Git
    • Install vcpkg
    • Install CUDA Toolkit & NVIDIA drivers
    • Install an IDE
  • Build and use
    • Caching
    • Manifest mode
    • Classic mode
    • Examples
  • About vcpkg ports
    • Rat-vcpkg ports
  • About vcpkg registries
    • Maintain
  • Checks
    • Checks for Armadillo
    • Checks for CUDA
    • Checks for OpenBLAS single-threaded
• Rat-Containers
  • Setup
    • Containerization solution
  • SingularityCE
    • Install
    • Build containers
    • Build examples
    • Use containers
    • Use examples
• pyRat
  • Introduction
  • Module pyrat
    • Python and C++
    • CLI : pyrat.cli
    • Color : pyrat.col
    • Log : pyrat.log
    • Meta : pyrat.meta
    • Rat : pyrat.rat
  • Setup
    • Prerequisites
    • Install UV
  • Build
    • Overview
    • Scripts
    • Manual build
  • Tests
    • Structure
    • Run tests
  • Use
    • Install
    • Examples
    • Rat
  • About bindings
    • Structure
    • Rat bindings