Merge pull request #2 from ENCCS/update-ci-and-deps

Update CI and dependencies and fix most warnings.
ENCCS · Aug 30, 2024 · 4316f15 · 4316f15
2 parents 7a3f567 + a1c73f9
commit 4316f15
Show file tree

Hide file tree

Showing 8 changed files with 286 additions and 27 deletions.
diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml
@@ -17,16 +17,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # https://github.com/marketplace/actions/checkout
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           lfs: true
       # https://github.com/marketplace/actions/setup-python
       # ^-- This gives info on matrix testing.
       - name: Install Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: "3.12"
       # https://docs.github.com/en/actions/guides/building-and-testing-python#caching-dependencies
       # ^-- How to set up caching for pip on Ubuntu
       - name: Cache pip

diff --git a/Makefile b/Makefile
@@ -12,7 +12,10 @@ BUILDDIR      = _build
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+.PHONY: help Makefile requirements.in
+
+requirements.txt: requirements.in
+	uv pip compile $< -o $@
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

diff --git a/content/2.02_openfoam-handson.rst b/content/2.02_openfoam-handson.rst
@@ -135,7 +135,6 @@ Some stuff worth noting here:
 
 - After running the case we need to reconstruct not only the data but also the mesh, which was generated in parallel. For that, we use *reconstructParMesh*.
   The *-constant* flag makes it put the mesh directly into *constant/polyMesh*.
->>>>>>> 43626f76ddfad1862f79bbc9a72c0ba77f587f07
 
 
 Validating the model

diff --git a/content/index.rst b/content/index.rst
@@ -21,7 +21,6 @@ OpenFOAM training workshop
    :maxdepth: 1
    :caption: Reference
 
-   setup
    quick-reference
    guide
 
@@ -49,15 +48,15 @@ Schedule
    * - 9:00 -  9:15
      - Welcome and introduction to the training course
    * - 9:15 -  10:00 
-     - Introduction to PDC and the HPC system (`Slides <https://github.com/ENCCS/OpenFOAM/blob/main/getting_started_with_Tegner.pdf>`_)
+     - Introduction to PDC and the HPC system (`Slides <https://github.com/ENCCS/OpenFOAM/blob/main/getting_started_with_Tegner.pdf>`__)
    * - 10:00 - 10:15
      - Break
    * - 10:15 - 11:00
-     - Introduction to the finite volume (FV) method  (`Slides <https://github.com/ENCCS/OpenFOAM/blob/main/day1_finite_volume.pdf>`_) 
+     - Introduction to the finite volume (FV) method  (`Slides <https://github.com/ENCCS/OpenFOAM/blob/main/day1_finite_volume.pdf>`__) 
    * - 11:00 - 11:15
      - Break
    * - 11:15 - 12:00 
-     - Workflow overview for OpenFOAM (`Slides <https://github.com/ENCCS/OpenFOAM/blob/main/day1_overview_of_openfoam.pdf>`_)
+     - Workflow overview for OpenFOAM (`Slides <https://github.com/ENCCS/OpenFOAM/blob/main/day1_overview_of_openfoam.pdf>`__)
    * - 12:00 - 13:00
      - Lunch break
    * - 13:00 - 15:00
@@ -70,11 +69,11 @@ Schedule
    * - Day 2
      -
    * - 9:15 -  10:00
-     - Function objects (`Slides <https://github.com/ENCCS/OpenFOAM/blob/main/day_2_function_objects.pdf>`_) 
+     - Function objects (`Slides <https://github.com/ENCCS/OpenFOAM/blob/main/day_2_function_objects.pdf>`__) 
    * - 10:00 - 10:15
      - Break
    * - 10:15 - 11:00
-     - Mesh generation and parallelization (`Slides <https://github.com/ENCCS/OpenFOAM/blob/main/day2_meshing.pdf>`_)
+     - Mesh generation and parallelization (`Slides <https://github.com/ENCCS/OpenFOAM/blob/main/day2_meshing.pdf>`__)
    * - 11:00 - 11:15
      - Break
    * - 11:15 - 12:00

diff --git a/content/numerics.rst b/content/numerics.rst
@@ -119,7 +119,7 @@ Interpolation schemes are specified in the ``fvSchemes`` file under the interpol
 
    .. tab:: InterpolationSchemes
 
-      .. code-block:: txt
+      .. code-block:: cpp
 
          interpolationSchemes
          {
@@ -164,7 +164,7 @@ Now it is the time to choose a time integration scheme. Temporal schemes define
 
    .. tab:: Time scheme properties
 
-      .. code-block:: txt
+      .. code-block:: cpp
 
          ddtSchemes
          {
@@ -203,7 +203,7 @@ Gradient schemes are specified in the fvSchemes file under the gradSchemes sub-d
 
    .. tab:: gradSchemes
 
-      .. code-block:: txt
+      .. code-block:: cpp
 
             gradSchemes
             {
@@ -243,7 +243,7 @@ Divergence schemes are specified in the fvSchemes file under the divSchemes sub-
 
    .. tab:: Time scheme properties
 
-      .. code-block:: txt
+      .. code-block:: cpp
 
             divSchemes
             {
@@ -258,7 +258,7 @@ A typical use is for convection schemes, which transport a property under the in
 
    .. tab:: divSchemes
 
-      .. code-block:: txt
+      .. code-block:: cpp
 
             divSchemes
             {
@@ -305,7 +305,7 @@ Laplacian schemes are specified in the fvSchemes file under the laplacianSchemes
 
    .. tab:: laplacianSchemes
 
-      .. code-block:: txt
+      .. code-block:: cpp
 
             laplacianSchemes
             {
@@ -325,7 +325,7 @@ Surface-normal gradient schemes are specified in the fvSchemesfile under the snG
 
    .. tab:: snGradSchemes
 
-      .. code-block:: txt
+      .. code-block:: cpp
             
             snGradSchemes
             {

diff --git a/content/workflow.rst b/content/workflow.rst
@@ -94,7 +94,7 @@ A few examples of the dictionaries are shown below:
 
    .. tab:: controlDict
 
-      .. code-block:: txt
+      .. code-block:: cpp
 
             /*--------------------------------*- C++ -*----------------------------------*\
             | =========                 |                                                 |
@@ -149,7 +149,7 @@ A few examples of the dictionaries are shown below:
 
    .. tab:: fvSchemes
 
-      .. code-block:: txt
+      .. code-block:: cpp
 
             /*--------------------------------*- C++ -*----------------------------------*\
             | =========                 |                                                 |
@@ -205,7 +205,7 @@ A few examples of the dictionaries are shown below:
 
    .. tab:: fvSolution
 
-      .. code-block:: txt
+      .. code-block:: cpp
 
             /*--------------------------------*- C++ -*----------------------------------*\
             | =========                 |                                                 |
@@ -273,7 +273,7 @@ OpenFOAM input dictionaries are designed to be human-readable ASCII text files,
 
    .. tab:: dictionary
 
-      .. code-block:: txt
+      .. code-block:: cpp
 
             dictionary_name
             {

diff --git a/requirements.in b/requirements.in
@@ -0,0 +1,5 @@
+Sphinx
+sphinx_rtd_theme>=2.0
+sphinx_rtd_theme_ext_color_contrast
+myst_nb
+sphinx-lesson