Skip to content

Commit

Permalink
Merge branch 'develop' into 281-add-algebraic-solutions-documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
prudhomm authored Jan 6, 2025
2 parents 5c0f574 + 30f04ff commit df2e907
Show file tree
Hide file tree
Showing 5 changed files with 142 additions and 542 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:

jobs:
build:
runs-on: self-ubuntu-22.04
runs-on: self-ubuntu-24.04
steps:
- uses: actions/checkout@v4
with:
Expand Down
24 changes: 21 additions & 3 deletions docs/dev/modules/reference/pages/codingrules.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,9 @@ public:
private:
//! member
int member;
int M_member;
//! another member
int member_;
};
//! the function
Expand Down Expand Up @@ -231,14 +233,16 @@ class MeshAdaptation {};
----

* Non-static data members name of structures and classes always start with `M_` . M stands for Member. The rational behind this is for example :
* Non-static data members name of structures and classes always start with `M_` . M stands for Member, or adding `_` at the end of the member name. The rational behind this is for example :
** to be able to immediately see that the data is a member of a class or a struct
** to easily search and query-replace

[source,cpp]
----
// Wong
class meshAdaptation { std::vector directions; };
// Wrong
// Correct
class meshAdaptation { std::vector directions_; };
// Correct
Expand All @@ -252,6 +256,8 @@ class MeshAdaptation { std::vector M_directions; };

[source,cpp]
----
// Wrong
class meshAdaptation { static std::vector directions; };
// Wrong
class meshAdaptation { static std::vector directions_; };
Expand Down Expand Up @@ -356,7 +362,19 @@ if (address.isEmpty() || !isValid() || !codec)
{
return false;
}
else
{
return true;
}
// Wrong
if (address.isEmpty() || !isValid() || !codec) {
return false;
}
else {
return truel
}
----

* Exception 2: Use braces also in if-then-else blocks where either the if-code or the else-code covers several lines
Expand Down
84 changes: 84 additions & 0 deletions docs/user/modules/install/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
:feelpp: Feel++
= Get {feelpp}


{feelpp} can be installed on Windows 10, Debian/Ubuntu systems.

The main channel is called `latest`.
Expand Down Expand Up @@ -135,6 +137,88 @@ To use {feelpp} on Windows 10, follow these steps:
* [x] follow the corresponding Ubuntu or Debian {feelpp} installation steps
include::partial$install-deb.adoc[]
--
Spack::
+
--
https://spack.io[Spack] packaging is available for {feelpp} thanks to ghcr.io.
Binaries are available for the generic microarchitecture `x86_64_v3`.
The following steps require the installation of Spack and the cloning of the `spack.numpex` repository.
[[spack]]
[discrete]
=== Clone Spack
[source,sh]
----
git clone https://github.com/spack/spack <path to spack>/spack
source <path to spack>/spack/share/spack/setup-env.sh
----
[discrete]
=== Add {feelpp} Spack Mirror
First set the {feelpp} mirror.
.set the {feelpp} spack mirror (only once)
[source,sh]
----
spack mirror add spack-mirror oci://ghcr.io/feelpp/spack <1>
----
<.> add the mirror named spack-mirror to spack
You can check the mirror with
[source,sh]
----
spack mirror list
----
[discrete]
=== Clone spack.numpex
Add `spack.numpex` as a spack repository
[source,sh]
----
git clone https://github.com/numpex/spack.numpex <path to spack.numpex>/spack.numpex
spack repo add <path to spack.numpex>/spack.numpex
# check the repo
spack repo list
----
[discrete]
=== Install {feelpp}
then download the package feelpp
[source,sh]
----
spack install --use-buildcache only --no-check-signature feelpp target=x86_64_v3
----
{feelpp} package as well as the dependencies will be installed.
You can check the package by run `spack test`
[source,sh]
----
spack test run feelpp
----
Then load the {feelpp} package
[source,sh]
----
spack load feelpp
----
Try get some info about {feelpp} using the command `feelpp_info`
[source,sh]
----
feelpp_info
----
--
Docker::
+
Expand Down
Loading

0 comments on commit df2e907

Please sign in to comment.