Merge pull request #738 from Pressio/develop

Update main from develop

Author: cwschilly

.github/workflows/ci-baseline.yml

@@ -86,7 +86,7 @@ jobs:
             -I/usr/include/eigen3 \
             -I${GITHUB_WORKSPACE}/pressio-log/include \
             -I${GITHUB_WORKSPACE}/pressio-ops/include \
-            -I${GITHUB_WORKSPACE}/pressio/include \
+            -I${GITHUB_WORKSPACE}/pressio-rom/include \
             -c main.cpp                \
           && $CXX --std=c++17 -o pressio-example main.o \
           && ./pressio-example
@@ -99,7 +99,7 @@ jobs:
             -I/usr/include/eigen3 \
             -I${GITHUB_WORKSPACE}/pressio-log/include \
             -I${GITHUB_WORKSPACE}/pressio-ops/include \
-            -I${GITHUB_WORKSPACE}/pressio/include \
+            -I${GITHUB_WORKSPACE}/pressio-rom/include \
             -c main_with_defines.cpp   \
           && $CXX --std=c++17 -o pressio-example main.o \
           && ./pressio-example

.github/workflows/ci-kokkos.yml

@@ -82,7 +82,7 @@ jobs:
             -I/kokkos-kernels/install/include \
             -I${GITHUB_WORKSPACE}/pressio-log/include \
             -I${GITHUB_WORKSPACE}/pressio-ops/include \
-            -I${GITHUB_WORKSPACE}/pressio/include \
+            -I${GITHUB_WORKSPACE}/pressio-rom/include \
             -c main.cpp
 
       - name: Example - include only with embedded definitions
@@ -95,7 +95,7 @@ jobs:
             -I/kokkos-kernels/install/include \
             -I${GITHUB_WORKSPACE}/pressio-log/include \
             -I${GITHUB_WORKSPACE}/pressio-ops/include \
-            -I${GITHUB_WORKSPACE}/pressio/include \
+            -I${GITHUB_WORKSPACE}/pressio-rom/include \
             -c main_with_defines.cpp
 
       - name: Configure Tests

.github/workflows/ci-trilinos.yml

@@ -78,7 +78,7 @@ jobs:
           -I${trilinos_dir}/include       \
           -I${GITHUB_WORKSPACE}/pressio-log/include \
           -I${GITHUB_WORKSPACE}/pressio-ops/include \
-          -I${GITHUB_WORKSPACE}/pressio/include \
+          -I${GITHUB_WORKSPACE}/pressio-rom/include \
           -c main.cpp
 
     - name: Example - include only with embedded definitions
@@ -91,7 +91,7 @@ jobs:
           -I${trilinos_dir}/include       \
           -I${GITHUB_WORKSPACE}/pressio-log/include \
           -I${GITHUB_WORKSPACE}/pressio-ops/include \
-          -I${GITHUB_WORKSPACE}/pressio/include \
+          -I${GITHUB_WORKSPACE}/pressio-rom/include \
           -c main_with_defines.cpp
 
     - name: Configure Tests

CMakeLists.txt

@@ -1,9 +1,9 @@
 cmake_minimum_required(VERSION 3.18.0 FATAL_ERROR)
-project(pressio C CXX)
+project(pressio-rom C CXX)
 
 # tests
 #=====================================================================
-option(PRESSIO_ENABLE_TESTS "Enable testing for pressio" OFF)
+option(PRESSIO_ENABLE_TESTS "Enable testing for pressio-rom" OFF)
 if(PRESSIO_ENABLE_TESTS)
   enable_testing()
   add_subdirectory(tests)

README.md

@@ -17,7 +17,7 @@ you might find useful some of the components of the library.
 
 Click below to checkout the documentation:
 
-<a href="https://pressio.github.io/pressio" target="_blank">
+<a href="https://pressio.github.io/pressio-rom" target="_blank">
     <img src='./logos/logo-readme.svg' width='97%'>
 </a>
 

docs/source/concepts_note.rst

@@ -14,13 +14,13 @@ notions that are at the core of our design approach.
 ``concept = syntactic constraints + semantics``
 -----------------------------------------------
 
-In pressio, we follow the approach in "Design of Concept Libraries for C++" (2011)
+In pressio-rom, we follow the approach in "Design of Concept Libraries for C++" (2011)
 in defining a concept to be a *meaningful combination of syntactic requirements + axioms/semantics*.
 Pure syntax can be fully specified and checked by compilers supporting C++20.
 On the contrary, axioms/semantics properties cannot be spelled out and statically checked.
 Axioms are, in fact, invariants *assumed* to hold. In the C++ standard, axioms
 and semantics are specified/listed as comments. Here, we adopt a different
-approach to present axioms (similar to "Design of Concept Libraries for C++", 2011)),
+approach to present axioms (similar to "Design of Concept Libraries for C++", 2011),
 that we believe benefits readability: axioms are explicitly listed using
 the keyword "axiom". Note, however, that if you want to compile the concepts below
 using a C++20 compiler, you have to comment out all axioms.

docs/source/conf.py

@@ -20,7 +20,7 @@
 # The master toctree document.
 master_doc = "index"
 
-project = 'Pressio'
+project = 'Pressio-ROM'
 # copyright = f'{datetime.datetime.now().year}, 2021, National Technology & Engineering Solutions of Sandia, LLC (NTESS)'
 copyright = u"2021, National Technology & Engineering Solutions of Sandia, LLC (NTESS)"
 author = 'Francesco Rizzi'

docs/source/configuration.rst

@@ -6,21 +6,21 @@ Configuration and Dependencies
 
 .. tip::
 
-    pressio is header-only, so it does not need to be precompiled and linked to.
+    pressio-rom is header-only, so it does not need to be precompiled and linked to.
 
 .. warning::
 
-    To use pressio, you need at least a C++17 compiler.
+    To use pressio-rom, you need at least a C++17 compiler.
 
 Dependencies
 ------------
 
-Some parts of ``pressio`` contain code and implementations
+Some parts of ``pressio-rom`` contain code and implementations
 that are specific to third-party libraries (TPLs).
 The main reason for doing this is that we aim, where possible,
-to alleviate the user from writing custom operations and allow ``pressio`` to decide when and how to leverage
+to alleviate the user from writing custom operations and allow ``pressio-rom`` to decide when and how to leverage
 the native libraries' operations to obtain the best performance.
-This should facilitate the integration and use of ``pressio`` by existing applications.
+This should facilitate the integration and use of ``pressio-rom`` by existing applications.
 This is a growing capability and we currently only
 provide built-in support to some external HPC libraries (see below).
 Obviously, these TPLs-specific specializations need to be guarded with
@@ -70,16 +70,18 @@ default choice for instantiating the ROM data structures
 and solving the (dense) ROM problem.
 
 In practice, what are the steps to get and use Pressio?
-----------------------------------------------------------------
+-------------------------------------------------------
 
-1. Clone `pressio <https://github.com/Pressio/pressio>`_ (defaults to the main branch),
-or you can pick a `release version <https://github.com/Pressio/pressio/releases>`_
+.. TODO: Add spack instructions once merged
+
+1. Clone `pressio-rom <https://github.com/Pressio/pressio-rom>`_ (defaults to the main branch),
+or you can pick a `release version <https://github.com/Pressio/pressio-rom/releases>`_
 
 2. Clone `pressio-ops <https://github.com/Pressio/pressio-ops>`_ and, optionally, `pressio-log <https://github.com/Pressio/pressio-log>`_
 
-3. Add the ``pressio/include``, ``pressio-ops/include``, and (optionally) ``pressio-log/include`` to your project's include directories.
+3. Add the ``pressio-rom/include``, ``pressio-ops/include``, and (optionally) ``pressio-log/include`` to your project's include directories.
 
-4. Use the Pressio library
+4. Use the Pressio ecosystem
 
 Before including any Pressio files, be sure to identify any third-party dependencies as discussed above.
 You can define macros to enable or disable code related to these dependencies.
@@ -114,7 +116,7 @@ Testing
 
 The following steps explain how to build and runs the Pressio tests.
 
-1. Begin by cloning `pressio <https://github.com/Pressio/pressio>`_.
+1. Begin by cloning `pressio-rom <https://github.com/Pressio/pressio-rom>`_.
 
 .. tip::
 
@@ -128,41 +130,39 @@ The following steps explain how to build and runs the Pressio tests.
 
 .. code-block:: bash
 
-   cd <where-you-cloned-pressio>
+   cd <where-you-cloned-pressio-rom>
    mkdir build && mkdir install
 
-3. Use cmake to configure by passing to the command line the target list of CMake variables to define.
+3. Use CMake to configure by passing to the command line the target list of CMake variables to define.
 
 For example, suppose we want to enable support for Trilinos and the logger. We would do:
 
 .. code-block:: bash
 
-   export PRESSIO_SRC=<where-you-cloned-pressio>
-   cd <where-you-cloned-pressio>/build
+   export PRESSIO_ROM_SRC=<where-you-cloned-pressio-rom>
+   cd ${PRESSIO_ROM_SRC}/build
 
    cmake -D PRESSIO_ENABLE_TPL_TRILINOS=ON \
          -D PRESSIO_ENABLE_LOGGING=ON \
          -D PRESSIO_ENABLE_TESTS=ON \
-         ${PRESSIO_SRC}
+         ${PRESSIO_ROM_SRC}
 
    make # tests are built
 
-Note that this step **only builds tests** because ``pressio`` is header-only.
-If you want, inspect the file ``<where-you-cloned-pressio>/install/pressio_cmake_config.h``
-which contains the CMake variables configuration.
+Note that this step **only builds tests** because ``pressio-rom`` is header-only.
 
 By default, this step will also clone and link to the ``Pressio/pressio-ops`` library,
-which contains essential operations for ``pressio``.
+which contains essential operations for ``pressio-ROM``.
 
 .. tip::
 
-  Since the tests assume the role of an application using pressio, they will need
+  Since the tests assume the role of an application using pressio-rom, they will need
   to link against any TPLs that you enable. To specify the location of a library,
   use the following CMake variable: ``-D <tpl>_DIR=/path/to/tpl/install``.
 
 4. Run the tests
 
 .. code-block:: bash
 
-  cd <where-you-cloned-pressio>/build
+  cd <where-you-cloned-pressio-rom>/build
   ctest -j <np>

docs/source/index.rst

@@ -3,10 +3,10 @@
 
 .. include:: mydefs.rst
 
-pressio C++ library
+pressio-rom C++ library
 ===================
 
-Documentation of the `C++ library <https://github.com/Pressio/pressio>`__, one element of the `Pressio ecosystem <https://pressio.github.io/>`_.
+Documentation of the `C++ library <https://github.com/Pressio/pressio-rom>`__, one element of the `Pressio ecosystem <https://pressio.github.io/>`_.
 
 This work was started with a focus on projection-based reduced-order models (ROMs),
 which is a strongly **multidisciplinary** topic.
@@ -38,7 +38,7 @@ in version ``1.0.0`` a uniform maturity level across
 the ``rom``, ``ode``, and ``solvers`` components. Please keep this in mind while browsing
 the documentation and the code.
 
-The supported capabilities of ``Pressio/pressio`` are included in the table below.
+The supported capabilities of ``pressio-rom`` are included in the table below.
 Each component (level) of the stack depends on the ones below it.
 
 |
@@ -74,18 +74,18 @@ These components depend on the `Pressio/pressio-ops <https://github.com/Pressio/
 Get Started
 -----------
 
-* `Configure pressio <configuration.html>`_: (currently) it is a header-only library, so should be trivial
+* `Configure pressio-rom <configuration.html>`_: (currently) it is a header-only library, so should be trivial
 
 * Explore our `end-to-end ROM demos <https://pressio.github.io/pressio-tutorials/endtoend/readthisfirst.html>`_ to
-  see ``pressio/rom`` in action and to experiment directly
+  see ``pressio-rom`` in action and to experiment directly
 
 * Explore the `tutorials showing the individual capabilities <https://pressio.github.io/pressio-tutorials>`_
 
 
 Generic programming and concepts
 --------------------------------
 
-Arguably the main foundation of pressio is the use of
+Arguably the main foundation of pressio-rom is the use of
 generic programming--*or, more humbly, we can at least say that it is what we strive for*.
 Since the early development stages, we have relied on concept-driven design.
 Note, that, if you have used or use C++ templates, you *have* used
@@ -95,7 +95,7 @@ C++20 concepts are, in some sense, a way to *explicitly* formalize those expecta
 
 
 Until we can stably upgrade to C++20, we cannot by default use C++20 concepts,
-so we currently guard the concepts in pressio inside a
+so we currently guard the concepts in pressio-rom inside a
 preprocessor directive ``#ifdef PRESSIO_ENABLE_CXX20``.
 The behavior is as follows:
 
@@ -167,6 +167,6 @@ open an issue on `github <https://github.com/Pressio/pressio>`_.
    :hidden:
 
    Tutorials <https://pressio.github.io/pressio-tutorials>
-   GitHub Repo <https://github.com/Pressio/pressio>
-   Open an issue/feature req. <https://github.com/Pressio/pressio/issues>
+   GitHub Repo <https://github.com/Pressio/pressio-rom>
+   Open an issue/feature req. <https://github.com/Pressio/pressio-rom/issues>
    license

docs/source/keywords.rst

@@ -46,15 +46,15 @@ The following options control enabling TPLs:
 Obviously, the choice of which TPLs to enable is related to
 your application's dependency requirements.
 For example, if you have an application that relies on
-Trilinos data structures and want to use ``pressio``\ ,
+Trilinos data structures and want to use ``pressio-rom``\ ,
 then it makes sense to enable the Trilinos dependency.
 On the contrary, if you have an application that relies only on
 Eigen data structures, then it makes sense to only leave only Eigen on
 and disable the rest.
 
 Also, we note that some of the cmake variables listed above are connected
 and cannot be turned on individualy.
-For example, if we enable Trilinos then ``pressio`` automatically
+For example, if we enable Trilinos then ``pressio-rom`` automatically
 enables also Kokkos, BLAS, LAPACK and MPI.