Introduction

Project-Rat-Extras group banner

- Extra cheese for no fees!

About the group

Project-Rat offers a wonderful suite of open-source C++ libraries for magnetostatic simulations and magnet design. It is however not the most straightforward solution to enable for magnet researchers that are not well versed in the C++ development environment.

Project-Rat-Extras (or PRE) is thus born as a desire to ease access to the great Rat magnetic framework by providing definitions and recipes for vcpkg ports, Singularity containers as well as Python bindings. These projects simplify the husstle of installating the Rat C++ libraries for those that are not familiar with thse concepts.

Of course this is partly due to the nature of compilation on Windows which required some specific ahead work in order to make it work in a consistent way using vcpkg. Linux installation is rather simple following steps from the base Rat documentation for the initiated to UNIX systems.

The group mainly emphasizes on the needs of CEA users at DRF/IRFU/DACM/LÉAS laboratory where it was born, hence its focus on Windows and Singularity for the time being. However it would be sad for other researchers not to enjoy these little helpers in their quests to design magnets, so these projects migrated from internal CEA GitLab to public GitLab under the MIT license following base Rat principles.

Development plan

PRE repositories are currently developed to suit the needs of the LÉAS laboratory as a side project rather than a main axis of development. Updates can vary depending on the needs and availability of maintainer(s) and projects. The group is however happily welcoming external contributions. If anything you are interested in is missing from the repositories, feel free to try and implement it before submitting requests to the projects branches.

CONTRIBUTING.md files are available in most repositories even though they are pretty lightweight and mainly serve as guidelines to fork and create merge requests for those interested in contributing.

Projects coverage

PRE provides several projects related to Rat. Some of them offers direct compilation and development environment support for C++ such as Rat-vcpkg and Rat-Containers, whereas as others are built on top of them, utilizing Rat libraries, such as pyRat.

        ---
align: center
alt: Projects workflow
name: workflow
config:
    theme: 'neutral'
---

    graph LR
        subgraph Compilation
            direction LR
            A(Rat-vcpkg)
            B(Rat-Containers)
        end

        Compilation == builds ==> C(Rat C++ libraries)
        C == used by ==> D(pyRat)

Other projects serve information and documentation such as this repository nicknamed PRE-Docs and the GitLab profile placeholder repository.

License

All repositories under the PRE group are licensed under the MIT following Project-Rat.

Credits

Authors:

Robin Penavaire, Guillaume Dilasser, Damien Minenna

Contributors:

CEA/DRF/IRFU/DACM/LÉAS