:orphan:

REMORA
------

REMORA is currently under development as a next-generation version of the Regional Ocean Modeling System (ROMS). The source code repository is hosted on `Github <https://github.com/seahorce-scidac/REMORA>`_. Questions and issues with the code can be directed to the developers by opening an Issue on the Github page. See our `Contributing <https://github.com/seahorce-scidac/REMORA/blob/development/CONTRIBUTING.md>`_ page for how to contribute code to the repository.

Like ROMS, REMORA solves the incompressible time-dependent Navier-Stokes equation with the Boussinesq and hydrostatic approximations. These equations are solved on a curvilinear grid with a stretched, terrain-following vertical coordinate. We use a split-explicit time-stepping shceme, where several fast barotropic (2D) steps take place within each baroclinic (3D) update. There are a number of user-specified options, including advection schemes, boundary conditions, mixing parametrizations, and surface flux parametrizations.

REMORA is built on `AMReX <https://github.com/AMReX-Codes/amrex>`_,
an adaptive mesh refinement software framework, which provides the underlying software infrastructure for
block structured AMR operations.
The full AMReX documentation can be found `here <https://amrex-codes.github.io/amrex/docs_html/>`_, and the tutorials can be found `here <https://amrex-codes.github.io/amrex/tutorials_html/>`_.

REMORA is designed to run on machines from laptops to multicore CPU and hybrid CPU/GPU systems.

This documentation is currently under development, there are detailed resources available on `the ROMS Documentation Portal <https://www.myroms.org/wiki/Documentation_Portal>`_ for the Regional Ocean Modeling System.

In addition to this documentation, there is API documentation for REMORA generated by `Doxygen <https://seahorce-scidac.github.io/docs/index.html>`_.

.. raw:: html

   <style>
   /* front page: hide chapter titles
    * needed for consistent HTML-PDF-EPUB chapters
    */
   div#userguide.section,
   div#theory.section,
   div#implementation.section,
   div#testing.section,
   </style>

.. toctree::
   :hidden:

   coc
   Doxygen.rst

.. toctree::
   :caption: USER GUIDE
   :maxdepth: 1
   :hidden:

   GettingStarted.rst
   Inputs.rst
   ProblemSetup.rst
   testing.rst

.. toctree::
   :caption: THEORY
   :maxdepth: 1
   :hidden:

   theory/Variables.rst
   theory/Equations.rst
   theory/VerticalMixing.rst

.. toctree::
   :caption: IMPLEMENTATION
   :maxdepth: 1
   :hidden:

   AMReX.rst
   ArakawaCGrid.rst
   BoundaryConditions.rst
   Checkpoint.rst
   Climatology.rst
   MeshRefinement.rst
   Numerical_Solution_Technique.rst
   Particles.rst
   Plotfiles.rst
   Time_Stepping.rst
   VerticalSCoord.rst
   Visualization.rst

.. toctree::
   :caption: TESTING
   :maxdepth: 1
   :hidden:

   Performance.rst
   RegressionTests.rst
   Verification.rst