parouby
/
Pamhyr2
mirror of https://gitlab.com/pamhyr/pamhyr2
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: dev: Introduction + minor change.

mesh
Pierre-Antoine Rouby 2023-09-15 15:28:26 +02:00
parent 187135e62b
commit 445de3b777
1 changed files with 34 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
doc/dev/documentation.org
View File

@ -28,7 +28,22 @@
#+OPTIONS: toc:t #+OPTIONS: toc:t
#+LANGUAGE: UKenglish #+LANGUAGE: UKenglish
* TODO The environment * TODO Introduction
Pamhyr2 is free and open source graphical user interface (GUI) for 1D
hydro-sedimentary modelling of rivers developed in Python (with
version 3.8). It use PyQt at version 5 and matplotlib in version 3.4.1
or later for the user insterface (see {{{file(/requirements.txt)}}}
for details). The architecture of project code follow the Qt
Model/View architecture [fn:qt-arch] (see details in section
[[Architecture]]). Pamhyr2 packages can be build manually (see section
[[Building packages]]), but there are automatically build with the
gitlab-ci (see [[Setup the CI environment]]).
[fn:qt-arch] Qt Model/View documentation:
https://doc.qt.io/qt-5/model-view-programming.html (last access
2023-09-15)
* TODO Architecture * TODO Architecture
** TODO Model ** TODO Model
** TODO Solver ** TODO Solver
@ -39,6 +54,7 @@
** TODO Building packages ** TODO Building packages
*** TODO Linux *** TODO Linux
*** TODO Windows *** TODO Windows
** TODO Setup the CI environment
* TODO Documentation files * TODO Documentation files
This document and the user documentation are org[fn:org] files. This text file This document and the user documentation are org[fn:org] files. This text file
@ -47,8 +63,10 @@ PDF (with latex), ODT, HTML, etc. It was originally designed for the
GNUEmacs[fn:emacs] text editor, but can be edited with any text editor. Here we GNUEmacs[fn:emacs] text editor, but can be edited with any text editor. Here we
take a look at the different features used in these documents. take a look at the different features used in these documents.
[fn:org] The org-mode website: https://orgmode.org/ [fn:org] The org-mode website: https://orgmode.org/ (last access
2023-09-15)
[fn:emacs] The GNUEmacs project website: https://gnu.org/s/emacs/ [fn:emacs] The GNUEmacs project website: https://gnu.org/s/emacs/
(last access 2023-09-15)
** TODO Org-mode ** TODO Org-mode
*** Document structure *** Document structure
@ -56,7 +74,7 @@ take a look at the different features used in these documents.
Org uses the =*= character to define a new document section. To add a Org uses the =*= character to define a new document section. To add a
sub-section, you can add an additional =*= to the current section[fn:: sub-section, you can add an additional =*= to the current section[fn::
See document structure documentation: See document structure documentation:
https://orgmode.org/org.html#Headlines]. https://orgmode.org/org.html#Headlines (last access 2023-09-15)].
#+BEGIN_EXAMPLE #+BEGIN_EXAMPLE
* Top level headline * Top level headline
@ -72,7 +90,8 @@ https://orgmode.org/org.html#Headlines].
Org-mode is a markup file, using markup in the text to modify the Org-mode is a markup file, using markup in the text to modify the
appearance of a portion of text[fn:: See markup documentation: appearance of a portion of text[fn:: See markup documentation:
https://orgmode.org/org.html#Emphasis-and-Monospace]. https://orgmode.org/org.html#Emphasis-and-Monospace (last access
2023-09-15)].
| Markup | Results | | Markup | Results |
|--------------------+------------------| |--------------------+------------------|
@ -89,9 +108,9 @@ https://orgmode.org/org.html#Emphasis-and-Monospace].
If we export the file to PDF, org-mode use \LaTeX. So we can add some If we export the file to PDF, org-mode use \LaTeX. So we can add some
piece of \LaTeX into the document[fn:: See \LaTeX part in piece of \LaTeX into the document[fn:: See \LaTeX part in
documentation: https://orgmode.org/org.html#Embedded-LaTeX]. For documentation: https://orgmode.org/org.html#Embedded-LaTeX (last
exemple, we can add math formula like =$E=mc^2$= ($E=mc^2$) or access 2023-09-15)]. For exemple, we can add math formula like
=\[E=mc^2\]=: =$E=mc^2$= ($E=mc^2$) or =\[E=mc^2\]=:
\[E=mc^2\] \[E=mc^2\]
@ -114,14 +133,14 @@ It is also possible to add specific \LaTeX file header with
*** Macro *** Macro
In this document, we use a few macros[fn:: See marcos documentation In this document, we use a few macros[fn:: See marcos documentation
https://orgmode.org/org.html#Macro-Replacement] to simplify https://orgmode.org/org.html#Macro-Replacement (last access
writing. They allow you to define sequences of text to be replaced, so 2023-09-15)] to simplify writing. They allow you to define sequences
that the macro name is replaced by its value. They are defined in the of text to be replaced, so that the macro name is replaced by its
{{{file(doc/tools/macro.org)}}} file. Once defined, they can be used value. They are defined in the {{{file(doc/tools/macro.org)}}}
in the document as follows: ={{{<macro-name>}}}=. You can also have file. Once defined, they can be used in the document as follows:
macros with arguments, in this case: ={{{<macro-name>}}}=. You can also have macros with arguments, in this
={{{<macro-name>(arg1,...)}}}=. Les macros peuvent aussi utiliser du case: ={{{<macro-name>(arg1,...)}}}=. Les macros peuvent aussi
code emacs-lisp. utiliser du code emacs-lisp.
#+BEGIN_EXAMPLE #+BEGIN_EXAMPLE
# Exemple of macro définition # Exemple of macro définition