8 docs review

README.md

@@ -4,7 +4,9 @@
   </a>
 </p>
 
-[![Reference Paper 1](https://img.shields.io/badge/Reference%20Paper%201-https://doi.org/10.1016/j.apm.2024.06.040-gray?labelColor=blue&style=flat&link=https://doi.org/10.1016/j.apm.2024.06.040)](https://doi.org/10.1016/j.apm.2024.06.040) [![Reference Paper 2](https://img.shields.io/badge/Reference%20Paper%202-10.1016/j.nucengdes.2024.113105-gray?labelColor=blue&style=flat&link=https://www.sciencedirect.com/science/article/pii/S002954932400205X)](https://www.sciencedirect.com/science/article/pii/S002954932400205X) [![Docs](https://img.shields.io/badge/Docs-green?style=flat&link=https://ermete-lab.github.io/ROSE-pyforce/intro.html)](https://ermete-lab.github.io/ROSE-pyforce/intro.html) [![Tutorials](https://img.shields.io/badge/Tutorials-red?style=flat&link=https://ermete-lab.github.io/ROSE-pyforce/tutorials.html)](https://ermete-lab.github.io/ROSE-pyforce/tutorials.html)
+[![Reference Paper 1](https://img.shields.io/badge/Reference%20Paper%201-10.1016/j.apm.2024.06.040-gray?labelColor=blue&style=flat&link=https://doi.org/10.1016/j.apm.2024.06.040)](https://doi.org/10.1016/j.apm.2024.06.040) [![Reference Paper 2](https://img.shields.io/badge/Reference%20Paper%202-10.1016/j.nucengdes.2024.113105-gray?labelColor=blue&style=flat&link=https://www.sciencedirect.com/science/article/pii/S002954932400205X)](https://www.sciencedirect.com/science/article/pii/S002954932400205X)
+
+[![Docs](https://img.shields.io/badge/Docs-green?style=flat&link=https://ermete-lab.github.io/ROSE-pyforce/intro.html)](https://ermete-lab.github.io/ROSE-pyforce/intro.html) [![Tutorials](https://img.shields.io/badge/Tutorials-red?style=flat&link=https://ermete-lab.github.io/ROSE-pyforce/tutorials.html)](https://ermete-lab.github.io/ROSE-pyforce/tutorials.html)
 
 
 [![Testing pyforce](https://github.com/Steriva/ROSE-pyforce/actions/workflows/testing.yml/badge.svg)](https://github.com/Steriva/ROSE-pyforce/actions/workflows/testing.yml) [![JOSS draft paper](https://github.com/ERMETE-Lab/ROSE-pyforce/actions/workflows/draft-pdf.yml/badge.svg)](https://github.com/ERMETE-Lab/ROSE-pyforce/actions/workflows/draft-pdf.yml)
@@ -16,7 +18,11 @@
   - [Recent works with *pyforce*](#recent-works-with-pyforce)
 - [Installation](#installation)
 - [Tutorials](#tutorials)
-- [Authors](#authors)
+- [Authors and contributions](#authors-and-contributions)
+- [Community Guidelines](#community-guidelines)
+  - [Contribute to the Software](#contribute-to-the-software)
+  - [Reporting Issues or Problems](#reporting-issues-or-problems)
+  - [Seeking Support](#seeking-support)
 
 ## Description
 
@@ -82,7 +88,7 @@ keywords = {Hybrid Data-Assimilation, Generalized Empirical Interpolation Method
 
 - Antonio Cammi, Stefano Riva, Carolina Introini, Lorenzo Loi, and Enrico Padovani. Indirect Field Recon- struction and Sensor Positioning in Circulating Fuel Reactors using Data-Driven Model Order Reduction. In 2023 International Congress on Advances in Nuclear Power Plants, Gyeongju, Korea, April 2023.
 - Stefano Riva, Carolina Introini, and Antonio Cammi. Multi-Physics Model Correction with Data-Driven Reduced Order Modelling. In 32nd International Conference Nuclear Energy for New Europe (NENE2023), Portoroz, Slovenia, September 2023.
-- Stefano Riva, Sophie Deanesi, Carolina Introini, Stefano Lorenzi, and Antonio Cammi. Neutron Flux Re- construction from Out-Core Sparse Measurements using Data-Driven Reduced Order Modelling. In International Conference on Physics of Reactors (PHYSOR24), San Francisco, USA, April 2024.
+- Stefano Riva, Sophie Deanesi, Carolina Introini, Stefano Lorenzi, and Antonio Cammi. Neutron Flux Reconstruction from Out-Core Sparse Measurements using Data-Driven Reduced Order Modelling. In International Conference on Physics of Reactors (PHYSOR24), San Francisco, USA, April 2024.
 
 ## Installation
 The package can be installed using `pip`, make sure all the dependencies are installed (following these [steps](https://ermete-lab.github.io/ROSE-pyforce/installation.html#set-up-a-conda-environment-for-pyforce)). The requirements are listed [here](https://github.com/ERMETE-Lab/ROSE-pyforce/blob/main/pyforce/requirements.txt).
@@ -113,7 +119,7 @@ The *pyforce* package is tested on some tutorials available in the [docs](https:
 
 The snapshots can be either generated by the user or be downloaded at the following link [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11483677.svg)](https://doi.org/10.5281/zenodo.11483677)
 
-## Authors
+## Authors and contributions
 
 **pyforce** is currently developed and mantained at [Nuclear Reactors Group - ERMETE Lab](https://github.com/ERMETE-Lab) by
 
@@ -123,3 +129,24 @@ The snapshots can be either generated by the user or be downloaded at the follow
 under the supervision of Prof. Antonio Cammi.
 
 If interested, please contact [email protected], [email protected], [email protected]
+
+## Community Guidelines
+
+We welcome contributions and feedback from the community! Below are the guidelines on how to get involved:
+
+### Contribute to the Software
+If you would like to contribute, please follow these steps:
+
+1. Fork the repository.
+2. Implement your changes. If you're adding new features, we kindly ask that you include an example demonstrating how to use them.
+3. Submit a pull request for review.
+
+### Reporting Issues or Problems
+If you encounter any issues or bugs with *pyforce*, please report them through the GitHub [Issues](https://github.com/ERMETE-Lab/ROSE-pyforce/issues) page. Be sure to include detailed information to help us resolve the problem efficiently.
+
+### Seeking Support
+For support, you can either:
+- Open a discussion on the GitHub [Discussions](https://github.com/ERMETE-Lab/ROSE-pyforce/discussions) page.
+- Send an email directly to: [[email protected]](mailto:[email protected]) or [[email protected]](mailto:[email protected])
+
+Thank you for helping improve **pyforce**!

docs/Tutorials/01_DFG2_benchmark.rst

@@ -1,6 +1,8 @@
 Unsteady Laminar Navier Stokes - DFG2 benchmark
 =========================================================
 
+**Aim of this tutorial**: learn how to generate time-dependent snapshots, create the reduced space using POD and perform the online phase with POD with Interpolation (POD-I).
+
 The DFG2 benchmark is taken from the `FeatFlow Repository <https://wwwold.mathematik.tu-dortmund.de/~featflow/en/benchmarks/cfdbenchmarking/flow/dfg_benchmark2_re100.html>`_. 
 It's 2D version of a Flow Over Cylinder Problem, able to observe Von-Karman vortex shedding.