Skip to content

Commit f593ea8

Browse files
committed
updated tutorial 0
1 parent ba91ca3 commit f593ea8

File tree

4 files changed

+171
-56
lines changed

4 files changed

+171
-56
lines changed

doc/compilation.md

Lines changed: 41 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -248,14 +248,20 @@ The binary executable will be located in the `src` directory but a copy will be
248248

249249
```terminal
250250
$ ./feenox
251-
FeenoX v0.2.14-gbbf48c9
252-
a free no-fee no-X uniX-like finite-element(ish) computational engineering tool
251+
FeenoX v1.2.9-gba91ca3
252+
a cloud-first free no-fee no-X uniX-like finite-element(ish) computational engineering tool
253253
254254
usage: feenox [options] inputfile [replacement arguments] [petsc options]
255255
256256
-h, --help display options and detailed explanations of command-line usage
257257
-v, --version display brief version information and exit
258258
-V, --versions display detailed version information
259+
-c, --check validates if the input file is sane or not
260+
--pdes list the types of PROBLEMs that FeenoX can solve, one per line
261+
--elements_info output a document with information about the supported element types
262+
--ast dump an abstract syntax tree of the input
263+
--linear force FeenoX to solve the PDE problem as linear
264+
--non-linear force FeenoX to solve the PDE problem as non-linear
259265
260266
Run with --help for further explanations.
261267
$
@@ -265,10 +271,10 @@ The `-v` (or `--version`) option shows the version and a copyright notice:
265271

266272
```terminal
267273
$ ./feenox -v
268-
FeenoX v0.2.14-gbbf48c9
269-
a free no-fee no-X uniX-like finite-element(ish) computational engineering tool
274+
FeenoX v1.2.9-gba91ca3
275+
a cloud-first free no-fee no-X uniX-like finite-element(ish) computational engineering tool
270276
271-
Copyright © 2009--2022 https://seamplex.com/feenox
277+
Copyright © 2009--2025 Jeremy Theler, https://seamplex.com/feenox
272278
GNU General Public License v3+, https://www.gnu.org/licenses/gpl.html.
273279
FeenoX is free software: you are free to change and redistribute it.
274280
There is NO WARRANTY, to the extent permitted by law.
@@ -279,22 +285,19 @@ The `-V` (or `--versions`) option shows the dates of the last commits, the compi
279285

280286
```terminal
281287
$ ./feenox -V
282-
FeenoX v0.1.24-g6cfe063
283-
a free no-fee no-X uniX-like finite-element(ish) computational engineering tool
288+
FeenoX v1.2.9-gba91ca3
289+
a cloud-first free no-fee no-X uniX-like finite-element(ish) computational engineering tool
284290
285-
Last commit date : Sun Aug 29 11:34:04 2021 -0300
286-
Build date : Sun Aug 29 11:44:50 2021 -0300
291+
Last commit date : Mon Jan 26 14:12:53 2026 -0300
287292
Build architecture : linux-gnu x86_64
288-
Compiler version : gcc (Debian 10.2.1-6) 10.2.1 20210110
289-
Compiler expansion : gcc -Wl,-z,relro -I/usr/include/x86_64-linux-gnu/mpich -L/usr/lib/x86_64-linux-gnu -lmpich
290-
Compiler flags : -O3
291-
Builder : gtheler@chalmers
292-
GSL version : 2.6
293-
SUNDIALS version : 4.1.0
294-
PETSc version : Petsc Release Version 3.14.5, Mar 03, 2021
295-
PETSc arch :
296-
PETSc options : --build=x86_64-linux-gnu --prefix=/usr --includedir=${prefix}/include --mandir=${prefix}/share/man --infodir=${prefix}/share/info --sysconfdir=/etc --localstatedir=/var --with-option-checking=0 --with-silent-rules=0 --libdir=${prefix}/lib/x86_64-linux-gnu --runstatedir=/run --with-maintainer-mode=0 --with-dependency-tracking=0 --with-debugging=0 --shared-library-extension=_real --with-shared-libraries --with-pic=1 --with-cc=mpicc --with-cxx=mpicxx --with-fc=mpif90 --with-cxx-dialect=C++11 --with-opencl=1 --with-blas-lib=-lblas --with-lapack-lib=-llapack --with-scalapack=1 --with-scalapack-lib=-lscalapack-openmpi --with-ptscotch=1 --with-ptscotch-include=/usr/include/scotch --with-ptscotch-lib="-lptesmumps -lptscotch -lptscotcherr" --with-fftw=1 --with-fftw-include="[]" --with-fftw-lib="-lfftw3 -lfftw3_mpi" --with-superlu_dist=1 --with-superlu_dist-include=/usr/include/superlu-dist --with-superlu_dist-lib=-lsuperlu_dist --with-hdf5-include=/usr/include/hdf5/openmpi --with-hdf5-lib="-L/usr/lib/x86_64-linux-gnu/hdf5/openmpi -L/usr/lib/x86_64-linux-gnu/openmpi/lib -lhdf5 -lmpi" --CXX_LINKER_FLAGS=-Wl,--no-as-needed --with-hypre=1 --with-hypre-include=/usr/include/hypre --with-hypre-lib=-lHYPRE_core --with-mumps=1 --with-mumps-include="[]" --with-mumps-lib="-ldmumps -lzmumps -lsmumps -lcmumps -lmumps_common -lpord" --with-suitesparse=1 --with-suitesparse-include=/usr/include/suitesparse --with-suitesparse-lib="-lumfpack -lamd -lcholmod -lklu" --with-superlu=1 --with-superlu-include=/usr/include/superlu --with-superlu-lib=-lsuperlu --prefix=/usr/lib/petscdir/petsc3.14/x86_64-linux-gnu-real --PETSC_ARCH=x86_64-linux-gnu-real CFLAGS="-g -O2 -ffile-prefix-map=/build/petsc-pVufYp/petsc-3.14.5+dfsg1=. -flto=auto -ffat-lto-objects -fstack-protector-strong -Wformat -Werror=format-security -fPIC" CXXFLAGS="-g -O2 -ffile-prefix-map=/build/petsc-pVufYp/petsc-3.14.5+dfsg1=. -flto=auto -ffat-lto-objects -fstack-protector-strong -Wformat -Werror=format-security -fPIC" FCFLAGS="-g -O2 -ffile-prefix-map=/build/petsc-pVufYp/petsc-3.14.5+dfsg1=. -flto=auto -ffat-lto-objects -fstack-protector-strong -fPIC -ffree-line-length-0" FFLAGS="-g -O2 -ffile-prefix-map=/build/petsc-pVufYp/petsc-3.14.5+dfsg1=. -flto=auto -ffat-lto-objects -fstack-protector-strong -fPIC -ffree-line-length-0" CPPFLAGS="-Wdate-time -D_FORTIFY_SOURCE=2" LDFLAGS="-Wl,-Bsymbolic-functions -flto=auto -Wl,-z,relro -fPIC" MAKEFLAGS=w
297-
SLEPc version : SLEPc Release Version 3.14.2, Feb 01, 2021
293+
Compiler version : gcc (Debian 14.2.0-19) 14.2.0
294+
Compiler expansion : gcc -I/usr/lib/x86_64-linux-gnu/openmpi/include -I/usr/lib/x86_64-linux-gnu/openmpi/include/openmpi -L/usr/lib/x86_64-linux-gnu/openmpi/lib -lmpi
295+
Compiler flags : -O3 -flto=auto -no-pie
296+
GSL version : 2.8
297+
SUNDIALS version : 7.1.1
298+
PETSc version : Petsc Release Version 3.22.5, Mar 28, 2025
299+
PETSc options : --build=x86_64-linux-gnu --prefix=/usr --includedir=${prefix}/include --mandir=${prefix}/share/man --infodir=${prefix}/share/info --sysconfdir=/etc --localstatedir=/var --with-option-checking=0 --with-silent-rules=0 --libdir=${prefix}/lib/x86_64-linux-gnu --runstatedir=/run --with-maintainer-mode=0 --with-dependency-tracking=0 --with-debugging=0 --with-library-name-suffix=_real --with-shared-libraries --with-pic=1 --with-cc=mpicc --with-cxx=mpicxx --with-fc=mpif90 --with-cxx-dialect=C++11 --with-opencl=1 --with-blas-lib=-lblas --with-lapack-lib=-llapack --with-scalapack=1 --with-scalapack-lib=-lscalapack-openmpi --with-fftw=1 --with-fftw-include="[]" --with-fftw-lib="-lfftw3 -lfftw3_mpi" --with-yaml=1 --with-hdf5-include=/usr/include/hdf5/openmpi --with-hdf5-lib="-L/usr/lib/x86_64-linux-gnu/hdf5/openmpi -lhdf5 -L/usr/lib/x86_64-linux-gnu/openmpi/lib -lmpi_usempif08 -lmpi_usempi_ignore_tkr -lmpi_mpifh -lmpi " --CXX_LINKER_FLAGS=-Wl,--no-as-needed --with-ptscotch=1 --with-ptscotch-include=/usr/include/scotch --with-ptscotch-lib="-lptesmumps -lptscotch -lptscotcherr" --with-hypre=1 --with-hypre-include=/usr/include/hypre --with-hypre-lib=-lHYPRE --with-mumps=1 --with-mumps-include="[]" --with-mumps-lib="-ldmumps -lzmumps -lsmumps -lcmumps -lmumps_common -lpord" --with-suitesparse=1 --with-suitesparse-include=/usr/include/suitesparse --with-suitesparse-lib="-lspqr -lumfpack -lamd -lcholmod -lklu" --with-superlu=1 --with-superlu-include=/usr/include/superlu --with-superlu-lib=-lsuperlu --with-superlu_dist=1 --with-superlu_dist-include=/usr/include/superlu-dist --with-superlu_dist-lib=-lsuperlu_dist --prefix=/usr/lib/petscdir/petsc3.22/x86_64-linux-gnu-real --PETSC_ARCH=x86_64-linux-gnu-real CFLAGS="-g -O2 -Werror=implicit-function-declaration -ffile-prefix-map=/build/reproducible-path/petsc-3.22.5+dfsg1=. -fstack-protector-strong -fstack-clash-protection -Wformat -Werror=format-security -fcf-protection -fPIC" CXXFLAGS="-g -O2 -ffile-prefix-map=/build/reproducible-path/petsc-3.22.5+dfsg1=. -fstack-protector-strong -fstack-clash-protection -Wformat -Werror=format-security -fcf-protection -fPIC" FCFLAGS="-g -O2 -ffile-prefix-map=/build/reproducible-path/petsc-3.22.5+dfsg1=. -fstack-protector-strong -fstack-clash-protection -fcf-protection -fPIC -ffree-line-length-0" FFLAGS="-g -O2 -ffile-prefix-map=/build/reproducible-path/petsc-3.22.5+dfsg1=. -fstack-protector-strong -fstack-clash-protection -fcf-protection -fPIC -ffree-line-length-0" CPPFLAGS="-Wdate-time -D_FORTIFY_SOURCE=2" LDFLAGS="-Wl,-z,relro -fPIC" MAKEFLAGS=
300+
SLEPc version : SLEPc Release Version 3.22.2, Dec 02, 2024
298301
$
299302
```
300303

@@ -613,7 +616,14 @@ $
613616

614617
If you do not have root access or do not want to populate `/usr/local/bin`, you can either
615618

616-
* Configure with a different prefix (not covered here), or
619+
* Configure with your home as a prefix and add `$HOME/bin` to the path
620+
621+
```
622+
./configure --prefix=$HOME
623+
make
624+
make install
625+
export PATH=$PATH:$HOME/bin
626+
```
617627

618628
* Copy (or symlink) the `feenox` executable to `$HOME/bin`:
619629

@@ -634,10 +644,10 @@ Check that FeenoX is now available from any directory (note the command is `feen
634644
```terminal
635645
$ cd
636646
$ feenox -v
637-
FeenoX v0.2.14-gbbf48c9
638-
a free no-fee no-X uniX-like finite-element(ish) computational engineering tool
647+
FeenoX v1.2.9-gba91ca3
648+
a cloud-first free no-fee no-X uniX-like finite-element(ish) computational engineering tool
639649
640-
Copyright © 2009--2022 https://seamplex.com/feenox
650+
Copyright © 2009--2025 Jeremy Theler, https://seamplex.com/feenox
641651
GNU General Public License v3+, https://www.gnu.org/licenses/gpl.html.
642652
FeenoX is free software: you are free to change and redistribute it.
643653
There is NO WARRANTY, to the extent permitted by law.
@@ -689,18 +699,16 @@ The FeenoX executable will show the configured compiler and flags when invoked w
689699

690700
```terminal
691701
$ feenox --versions
692-
FeenoX v0.2.14-gbbf48c9
693-
a free no-fee no-X uniX-like finite-element(ish) computational engineering tool
702+
FeenoX v1.2.9-gba91ca3
703+
a cloud-first free no-fee no-X uniX-like finite-element(ish) computational engineering tool
694704
695-
Last commit date : Sat Feb 12 15:35:05 2022 -0300
696-
Build date : Sat Feb 12 15:35:44 2022 -0300
705+
Last commit date : Mon Jan 26 14:12:53 2026 -0300
697706
Build architecture : linux-gnu x86_64
698-
Compiler version : gcc (Debian 10.2.1-6) 10.2.1 20210110
699-
Compiler expansion : gcc -Wl,-z,relro -I/usr/include/x86_64-linux-gnu/mpich -L/usr/lib/x86_64-linux-gnu -lmpich
700-
Compiler flags : -O3
701-
Builder : gtheler@tom
702-
GSL version : 2.6
703-
SUNDIALS version : 5.7.0
707+
Compiler version : gcc (Debian 14.2.0-19) 14.2.0
708+
Compiler expansion : gcc -I/usr/lib/x86_64-linux-gnu/openmpi/include -I/usr/lib/x86_64-linux-gnu/openmpi/include/openmpi -L/usr/lib/x86_64-linux-gnu/openmpi/lib -lmpi
709+
Compiler flags : -O3 -flto=auto -no-pie
710+
GSL version : 2.8
711+
SUNDIALS version : 7.1.1
704712
PETSc version : Petsc Release Version 3.16.3, Jan 05, 2022
705713
PETSc arch : arch-linux-c-debug
706714
PETSc options : --download-eigen --download-hdf5 --download-hypre --download-metis --download-mumps --download-parmetis --download-pragmatic --download-scalapack

doc/git.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ If something goes wrong and you get an error, do not hesitate to ask in FeenoX's
6868
> ./configure --prefix=$HOME
6969
> make
7070
> make install
71+
> export PATH=$PATH:$HOME/bin
7172
> ```
7273
7374
To stay up to date, pull and then `autogen`, `configure` and `make` (and optionally install):

0 commit comments

Comments
 (0)