CanESM Porting Guide
====================

When appropriate, developers/users/sys-admins may wish/need to port the
``CanESM`` system to new research platforms. This document is
meant to guide this process.

.. warning::

    As of July 2025, this is a just a high level guide, that us a work in progress. 
    As more platforms are added to the supported list for the modelling system, this document should
    be updated as lessons are learned and more specific instructions are ironed
    out.

.. note::

   This documentation will act as a good starting place for the guide needed to deploy
   ``imsi``/``canesm`` on new platforms (including DRAC machines)

.. toctree::
    :maxdepth: 1
    :caption: Contents:

    software_dependencies/software_dependencies.rst
    input_files/input_files.rst
    runtime_diagnostics_browser/runtime_diagnostics_browser.rst
    configuration_files/configuration_files.rst