Merge pull request #7 from pacs-course/master

Updating branch for AY 24-25

.clang-format

@@ -5,7 +5,7 @@ AccessModifierOffset: -2
 AlignAfterOpenBracket: Align
 AlignConsecutiveMacros: false
 AlignConsecutiveAssignments: false
-AlignConsecutiveDeclarations: true
+AlignConsecutiveDeclarations: false
 AlignEscapedNewlines: Left
 AlignOperands:   true
 AlignTrailingComments: true
@@ -104,7 +104,7 @@ SortIncludes:    true
 SortUsingDeclarations: true
 SpaceAfterCStyleCast: false
 SpaceAfterLogicalNot: false
-SpaceAfterTemplateKeyword: true
+SpaceAfterTemplateKeyword: false
 SpaceBeforeAssignmentOperators: true
 SpaceBeforeCpp11BracedList: false
 SpaceBeforeCtorInitializerColon: true

CONTRIBUTING.md

@@ -1,8 +1,16 @@
 # Git repository of the examples used in the course on Advanced Programming for Scientitic Computing, Politecnico di Milano, Italy #
+Main Contributors over the years (in random order):
+Alberto Artoni
+Carlo de Falco
+Pasquale Claudio Africa
+Matteo Caldana
+Alessio Fumagalli
+Antonio Cervone
 
-Only a limited numbers of developers have full access rights.
+Only a limited numbers of developers have full access rights to the repository on Github.
 
-You are free to contribute by activating a pull request. You proposed chenges will be examined and, if considered appropriate, merged in the repository code.
+But you are welcom to contribute by activating a pull request. You proposed changes will be examined and, if considered appropriate, merged in the repository code.
 By contributing you accept the licence agreement contined in the root folder of the git repository.
 
 
+

Examples/README.md

@@ -1,27 +1,33 @@
-# Course on Advanced programming for scientific computing #
-## Mathematical Engineering, Politecnico di Milano ##
-## Copyright Luca Formaggia 2012-2023 ##
+# Examples of the Course on Advanced Programming for Scientific Computing (aka PACS)#
+**Mathematical Engineering, Politecnico di Milano**
+**Copyright Luca Formaggia 2012-2024**
 
 ## LICENCING ##
 The software contained in the subfolders of this directory is free-software released under a GNU General Public Licens (GPL). The details of the licence are availabe in the `COPYRIGHT` file in the root directory.
 
-
 ## CONTENT ##
 
-Here you find the examples given in the course
+`bin/` -> Directory where the executables are installed. It contains some scripts to beautify your code (see below)
+
+`lib/` -> Directory where the libraries are installed. Initially empty, but it will be filled with the libraries produced by the examples
+
+`lib64/` -> Only for compatibility. In fact is a link to `lib`
+
+`include/` -> General include files. Initially empty, but it will be filled with the include files of the examples
 
-`doc` -> Possible additional documentation
+`share/` -> Directory where the documentation is installed. Initially empty, but it will be filled with the documentation of the examples
 
-`lib` -> Possible libraries needed to compile some example
+`src/` -> Directory with the example sources. Probably the most important directory. Look at the `CONTENT.md` file for a description of the examples.
 
-`include` -> General include files
+`astyle_scripts_and_hooks/` Some tools to beautify your code, based on [Artistic Style](http://astyle.sourceforge.net/) (you mast install astyle if you wish to use the tools in this directory).
 
-`src` -> Directory with the example sources
+`clang-format_scripts_and_hooks/` Some tools to beautify your code, based on [clang-format](https://www.electronjs.org/docs/latest/development/clang-format) (you must have clang-tools installed! if you want to use the utilities in this directory)
 
-`astyle_scripts_and_hooks` Some tools to beautify your code, based on [Artistic Style](http://astyle.sourceforge.net/) (you mast install astyle if you wish to use the tools in this directory).
+`environment.sh` A bash script that sets the environment variables needed by the examples. It can simplify life if you are not using the mk-modules adopted in the course. In that case you can copy it in your `.profile` file in your home directory (see note at the end of the file), **after having changed the path correctly**. 
 
-`clang-format_scripts_and_hooks` Some tools to beautify your code, based on [clang-format](https://www.electronjs.org/docs/latest/development/clang-format) (you must have clang-tools installed! if you want to use the utilities in this directory).
+`Makefile.user` A makefile that you must copy to `Makefile.inc` and edit to suit your system. It is used by all the examples. It is explained in the next section.
 
+`setup.sh` A bash script that compiles the main utilities in one shot so that you have averything set. It is explained in the next section.
 
 ## HOW TO COMPILE AND INSTALL THE EXAMPLES: ##
 
@@ -201,6 +207,13 @@ Here the tests have been collected in the subfolder `test`, but the rule is the
 
 Have a look at the tests because they contain information on how to use the utilities!
 
+To simplify life, you can just do
+```bash
+bash ./setup.sh
+```
+and averything is done for you.
+
+
 ### THIRD STEP EXTRAS ###
 Some utilities that are used in a few examples (and interesting on their own) are kept as submodules, since they refer to third party software.
 To compile and install them, go in the `Extras` directory of the repository and follow the instructions in the `README.md` file stored in that directory.
@@ -236,7 +249,6 @@ installed. Anyway, a copy of `directories.html` is present in this directory.
 ### The content of `src` Directory ###
 A description of the examples in the `src` directory is found in `CONTENT.md`.
 
-
 ### A note on `.bashrc` or `.profile` (or `.bash_profile`) ### 
 
 To control the settings of your Linux environment everytime you login