Skip to content

Commit

Permalink
Merge branch 'develop' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
@fnrizzi
fnrizzi committed Sep 27, 2021
2 parents dde5936 + a595773 commit ff79a97
Show file tree
Hide file tree
Showing 54 changed files with 179 additions and 83 deletions.
30 changes: 20 additions & 10 deletions CMakeLists.txt
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,36 @@

cmake_minimum_required(VERSION 2.8.12)
cmake_minimum_required(VERSION 3.18.0)
project(pressio-tutorials CXX)
set (CMAKE_CXX_STANDARD 11)

#===================================================
# c++ standard
#===================================================
# commands to test if compiler supports standard
include(CheckCXXCompilerFlag)
check_cxx_compiler_flag("-std=c++14" COMPILER_SUPPORT_CPP14)
if(NOT COMPILER_SUPPORT_CPP14)
message(FATAL_ERROR "Compiler does not support -std=c++14. This is required.")
endif()
set(CMAKE_CXX_STANDARD 14)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_EXTENSIONS OFF)

#===================================================
include_directories(
${CMAKE_CURRENT_SOURCE_DIR}/tpls/eigen/eigen3
${CMAKE_CURRENT_SOURCE_DIR}/tpls
${CMAKE_CURRENT_SOURCE_DIR}/tpls/pressio/include)

set(TUTDIR ${CMAKE_CURRENT_SOURCE_DIR}/tutorials)

#===================================================
# add all executables
#===================================================
add_executable(
utils_logger
${TUTDIR}/utils_logger.cc)

#=================================
# nonlinear solvers
#=================================
add_executable(
nonlinsolvers_newtonraphson_known_types
${TUTDIR}/nonlinsolvers_newtonraphson_1.cc)
Expand All @@ -33,9 +47,7 @@ add_executable(
nonlinsolvers_gn_custom_types
${TUTDIR}/nonlinsolvers_gn_2.cc)

#=================================
# ODE
#=================================
add_executable(
ode_steppers_known_types
${TUTDIR}/ode_steppers_1.cc)
Expand All @@ -48,9 +60,7 @@ add_executable(
ode_advancer
${TUTDIR}/ode_advancer.cc)

#=================================
# rom
#=================================
# rom decoder
add_executable(
rom_linear_decoder_known_types
${TUTDIR}/rom_linear_decoder_eigen.cc)
Expand All @@ -59,7 +69,7 @@ add_executable(
rom_linear_decoder_custom_types
${TUTDIR}/rom_linear_decoder_arbitrary_types.cc)

#---- galerkin -----
# rom galerkin
add_executable(
rom_default_explicit_galerkin_known_types
${TUTDIR}/rom_default_explicit_galerkin_eigen.cc)
Expand Down
17 changes: 9 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@

# pressio-tutorials

These tutorials cover examples on how users can interact with `pressio`
and demonstrate the reduced-order models (ROMs) capabilities of `pressio`.
This repository is continuously updated with tutorials covering
the [pressio C++ library](https://pressio.github.io/pressio/html/index.html).

# Userguide and documentation
You can find the full guide [here](https://pressio.github.io/pressio-tutorials/html/index.html).
[EXPLORE THE TUTORIALS WEBSITE!](https://pressio.github.io/pressio-tutorials/html/index.html)


## License and Citation

# License and Citation
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

The full license is available [here](https://pressio.github.io/various/license/).

We are working on publishing this: you can find our arXiv preprint at: https://arxiv.org/abs/2003.07798.
## Questions?

# Questions?
Find us on Slack: https://pressioteam.slack.com or open an issue on [github](https://github.com/Pressio/pressio-tutorials).
Find us on Slack: https://pressioteam.slack.com and/or
open an issue on [github](https://github.com/Pressio/pressio-tutorials).
2 changes: 2 additions & 0 deletions docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@
("<a href=\"md_pages_rom_galerkin_default_implicit_custom_types.html\">Default Implicit Galerkin (custom types)</a>", )
]),

("<a href=\"https://github.com/Pressio/pressio-tutorials\">Github Page</a>", []),

# these are here just to make the menu bar spaced better
("<a></a>", []),
("<a></a>", []),
Expand Down
3 changes: 2 additions & 1 deletion docs/html/advancers_8md.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/dir_208d2690607c4e3d3fabfa1d18673d36.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/dir_4708a13a89458f6d0cd5a4a9a3b52825.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/dir_4cccaec18f48de5ad93eff32399233b5.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/dir_6a89a6e57a3601fc15116e5484f781e5.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/dir_dfdc6e3fe3dd83592e3200d32aae2cb7.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/files.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/galerkin__default__explicit_8md.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/galerkin__default__explicit__custom__types_8md.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/galerkin__default__implicit_8md.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/galerkin__default__implicit__custom__types_8md.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
7 changes: 4 additions & 3 deletions docs/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand All @@ -77,11 +78,11 @@
<h1>
Pressio C++ Tutorials
</h1>
<p><a name="md_pages_main"></a></p><p>This website presents the <a href="https://github.com/Pressio/pressio-tutorials">C++ tutorials</a>, which use the <a href="https://pressio.github.io/pressio/html/index.html">pressio C++ core library</a>.<br /></p><section id="autotoc_md1"><h2><a href="#autotoc_md1">Get Started</a></h2><p>Requires CMake &gt; 3.13.0 and a C++ compiler with C++11 support:</p><pre class="m-code">git clone --recursive git@github.com:Pressio/pressio-tutorials.git
<p><a name="md_pages_main"></a></p><div class="m-frame m-default"><p>This website contains the tutorials covering the <a href="https://pressio.github.io/pressio/html/index.html">pressio C++ library</a>.</p><p>Disclaimer: this is still work-in-progress, some coverage might be missing. We plan to improve this over time.</p></div><section id="autotoc_md1"><h2><a href="#autotoc_md1">Building</a></h2><div class="m-note m-warning"><p>All you need CMake &gt; 3.18.0 and a C++14 compliant compiler.</p></div><pre class="m-code">git clone --recursive git@github.com:Pressio/pressio-tutorials.git
<span class="nb">export</span> <span class="nv">CXX</span><span class="o">=</span>&lt;path-to-your-CXX-compiler&gt;
<span class="nb">cd</span> pressio-tutorials <span class="o">&amp;&amp;</span> mkdir build <span class="o">&amp;&amp;</span> <span class="nb">cd</span> build
cmake -DCMAKE_BUILD_TYPE<span class="o">=</span>Release ..
make -j4</pre><p>The executables for all tutorials are built inside the build subdirectory.</p></section><section id="autotoc_md2"><h2><a href="#autotoc_md2">License and Citation</a></h2><p>The BSD-3 license is available <a href="https://pressio.github.io/various/license/">here</a>.</p><p>We are working on publishing this. Our arXiv preprint at: <a href="https://arxiv.org/abs/2003.07798">https:/<wbr />/<wbr />arxiv.org/<wbr />abs/<wbr />2003.07798</a></p></section><section id="autotoc_md3"><h2><a href="#autotoc_md3">Questions?</a></h2><p>Find us on Slack: <a href="https://pressioteam.slack.com">https:/<wbr />/<wbr />pressioteam.slack.com</a> or open an issue on <a href="https://github.com/Pressio/pressio-tutorials">github</a>.</p></section>
make -j4</pre><div class="m-note m-info"><p>Individual executables for all tutorials are built inside the build subdirectory.</p></div></section><section id="autotoc_md2"><h2><a href="#autotoc_md2">License and Citation</a></h2><p>The BSD-3 license is available <a href="https://pressio.github.io/various/license/">here</a>.</p><p>We are working on publishing this. Our arXiv preprint at: <a href="https://arxiv.org/abs/2003.07798">https:/<wbr />/<wbr />arxiv.org/<wbr />abs/<wbr />2003.07798</a></p></section><section id="autotoc_md3"><h2><a href="#autotoc_md3">Questions?</a></h2><p>Find us on Slack: <a href="https://pressioteam.slack.com">https:/<wbr />/<wbr />pressioteam.slack.com</a> or open an issue on <a href="https://github.com/Pressio/pressio-tutorials">github</a>.</p></section>
</div>
</div>
</div>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/logger_8md.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/main_8md.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/md_pages_ode_advancers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/md_pages_ode_steppers_tutorial1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
<li><a href="md_pages_rom_galerkin_default_implicit_custom_types.html">Default Implicit Galerkin (custom types)</a></li>
</ol>
</li>
<li><a href="https://github.com/Pressio/pressio-tutorials">Github Page</a></li>
<li><a></a></li>
<li><a></a></li>
<li><a></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="8">
<ol class="m-col-t-6 m-col-m-none" start="9">
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
Expand Down
Loading

0 comments on commit ff79a97

Please sign in to comment.