Rat-Containers
==============

.. image::
    ../_static/figs/rat-containers/banner-2.svg
   :alt: Project-Rat-Extras Rat-Containers banner
   :align: left
   :class: img-bottom-padding
   :width: 100 %

\- *Pick a cage, any cage...*

-----

Rat-Containers_ defines container utilities for
Project-Rat_ group C++ libraries for magnetic
simulations, mainly for **Linux-based** platforms,
such as definitions or recipes to build isolated
development environment for more controlled
compilation and packaging.

.. topic:: Linux VS Windows

    Linux is a bit more C/C++ friendly than Windows when it comes
    to compile code, as compilation and toolchain can require a
    lot more work whenever Visual Studio or MSVC are involved.

    **This documentation will therefore emphasize on Linux** since
    it is the primary target for the Rat-Containers_ repository.

.. seealso::
    
    For a more direct approach to compile Rat C++ libraries on Linux:
    `Installation (Linux)
    <https://gitlab.com/Project-Rat/rat-documentation#installation-linux>`__
    on Rat-Docs_.

    For compiling Rat C++ libraries on Windows:
    :doc:`../repo-rat-vcpkg/index`.

.. Rat-Containers table of contents
.. toctree::
   :maxdepth: 2
   :caption: RAT-CONTAINERS CONTENTS

   setup
   singularityCE/index

.. Links
.. _Project-Rat: https://gitlab.com/project-rat
.. _PRE Docs: https://gitlab.com/project-rat-extras/docs
.. _Rat-Docs: https://gitlab.com/project-rat/rat-documentation
.. _Rat-Containers: https://gitlab.com/project-rat-extras/rat-containers