Deploying to gh-pages from @ 683aa07 🚀

Documentation.md

@@ -356,6 +356,8 @@ pyft.expressions.
 
 ### The developer's point of view
 
+#### Separation into modules
+
 New methods must be added in one of the abstract classes defined in variables.py,
 statements.py... according to its main topic.
 The application.py file deals with methods specific to PHYEX that are not universal.
@@ -382,6 +384,24 @@ Several decorators are available:
     methods that introduce modifications into the tree. For this reason, the
     noParallel decorator *must appear* before the updateTree one.
 
+#### Coding standards
+
+Coding standards are checked using the pylint and flake8 tools. The aim is to have no messages
+from flake8 and to keep pylint's score above 9.8.
+
+The project is written in “lower camel case” with lines of up to 100 characters. As the main
+class is split into several sub-classes that are not independent, it is normal for pylint to
+detect accesses to attributes that are not members of the classes. The pyproject.toml and
+.flake8 files have been adapted to take account of these specificities.
+
+On top of this, the code is often complex and generates multiple “too many”
+branches/statements/lines/... messages, which are ignored.
+
+From the project root, tests are launched by commands:
+  - flake8 src/pyft/ bin/pyft\_\*.py
+  - pylint -d R0912,C0209,R0915,R1702,C0302,R0913,R0914,W1202,R0904,R0902 src/pyft/ bin/pyft\_\*.py
+
+
 ## Examples and tests
 
 The examples directory contains a script (tests.sh) that performs a non-regression test.

doxygen/html/classpyft_1_1applications_1_1Applications.html

@@ -129,7 +129,7 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><pre class="fragment">Methods for high-to-moderate level transformation
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00057">57</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00058">58</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 </div><h2 class="groupheader">Member Function Documentation</h2>
 <a id="ac4032e6a8ca8ed9c718532a4bffc5e52" name="ac4032e6a8ca8ed9c718532a4bffc5e52"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ac4032e6a8ca8ed9c718532a4bffc5e52">&#9670;&#160;</a></span>addDrHook()</h2>
@@ -148,7 +148,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac4032e6a8ca8ed9c718532a4
 </div><div class="memdoc">
 <pre class="fragment">Add DR_HOOK calls.
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00211">211</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00212">212</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -215,7 +215,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a249c5af425e2ec378979dc92
   CALL MPPDB_CHECK(PLM, "BL89 end:PLM")
 END IF
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00264">264</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00265">265</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -302,7 +302,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a94ecaa01e6f8c664ff792c3a
 
 Stacks are added to all routines called by the scopes listed in stopScopes
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00399">399</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00400">400</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -351,7 +351,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab154958fc7a4e7838fd85dbb
 </div><div class="memdoc">
 <pre class="fragment">build module files containing helpers to copy user type structures
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l01271">1271</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l01272">1272</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -410,7 +410,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8cf627c8687f44bee8811fed
 Not converted : TOTO%CST%XG (for now, recursion must be coded)
 Not converted : TOTO%ARRAY(:) (shape of the array must be determined from E1)
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00080">80</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00081">81</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -470,7 +470,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac9506b5cba0b7f353e417025
 If Simplify is True, also remove all variables only needed for these calls
 :param simplify : if True, remove variables that are now unused
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00236">236</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00237">237</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -595,7 +595,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a657504a66ad8b46931c85165
 DR_HOOK, LHOOK, YOMHOOK, JPRB, PARKIND1)
 :param simplify : if True, remove variables that are now unused
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00201">201</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00202">202</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -711,7 +711,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ace96a5126bcc967d8357e9e0
 If Simplify is True, also remove all variables only needed for these calls
 :param simplify : if True, remove variables that are now unused
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00063">63</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00064">64</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -834,7 +834,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5828b662d01e9189a7cce4fc
 If Simplify is True, also remove all variables only needed for these calls
 :param simplify : if True, remove variables that are now unused
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00253">253</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00254">254</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -895,7 +895,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4c57d266fc869934943f08cd
 <pre class="fragment">Transform array syntax into DO loops
 :param concurrent: use 'DO CONCURRENT' instead of simple 'DO' loops
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00779">779</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00780">780</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -993,7 +993,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#adb31dc154b8f4beac48bbd98
                   - name of the array
                   - index of the rank
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00481">481</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00482">482</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -1072,7 +1072,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac1cc6cfdb61ea1840e5c651d
 <pre class="fragment">Convert intrinsic math functions **, LOG, ATAN, **2, **3, **4, EXP, COS, SIN, ATAN2
 into a self defined function BR_ for MesoNH CPU/GPU bit-reproductibility
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00811">811</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00812">812</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -1166,7 +1166,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0a2733263d286cce63573f45
     e.g. CALL FOO(D, A(:,JK,1), B(:,:))
           ==&gt; CALL FOO(D, A(JIJ,JK,1), B(:,:)) only if the target argument is not an array
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00504">504</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00505">505</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -1279,7 +1279,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a92d39c515c46d1549df4b422
                  variable as kind selector, and if this variable is not used else where,
                  we also delete it)
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00757">757</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00758">758</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">
@@ -1355,7 +1355,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#adbe9314e24c6d0f21553a913
 table into the use of subroutines
 and use mnh_expand_directives to handle intermediate computations
 </pre> 
-<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00924">924</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="applications_8py_source.html#l00925">925</a> of file <a class="el" href="applications_8py_source.html">applications.py</a>.</p>
 <div class="dynheader">
 Here is the call graph for this function:</div>
 <div class="dyncontent">

doxygen/html/classpyft_1_1pyft_1_1PYFT.html

@@ -217,8 +217,8 @@
 <tr class="separator:a0b3e4c92ba20b1407bbfe3431dfd8a3b inherit pub_methods_classpyft_1_1scope_1_1ElementView"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a8461319837c2cd72801831c6eb5c8d59 inherit pub_methods_classpyft_1_1scope_1_1ElementView" id="r_a8461319837c2cd72801831c6eb5c8d59"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyft_1_1scope_1_1ElementView.html#a8461319837c2cd72801831c6eb5c8d59">items</a> (self, *args, **kwargs)</td></tr>
 <tr class="separator:a8461319837c2cd72801831c6eb5c8d59 inherit pub_methods_classpyft_1_1scope_1_1ElementView"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ace7f521dfab7cc2e0f15ba2fbc651b0d inherit pub_methods_classpyft_1_1scope_1_1ElementView" id="r_ace7f521dfab7cc2e0f15ba2fbc651b0d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyft_1_1scope_1_1ElementView.html#ace7f521dfab7cc2e0f15ba2fbc651b0d">clear</a> (self, *args, **kwargs)</td></tr>
-<tr class="separator:ace7f521dfab7cc2e0f15ba2fbc651b0d inherit pub_methods_classpyft_1_1scope_1_1ElementView"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad5e9e613e254d1311ce171f2e571e461 inherit pub_methods_classpyft_1_1scope_1_1ElementView" id="r_ad5e9e613e254d1311ce171f2e571e461"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyft_1_1scope_1_1ElementView.html#ad5e9e613e254d1311ce171f2e571e461">clear</a> (self)</td></tr>
+<tr class="separator:ad5e9e613e254d1311ce171f2e571e461 inherit pub_methods_classpyft_1_1scope_1_1ElementView"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a31d73ef3280d394c46a088ca5436958b inherit pub_methods_classpyft_1_1scope_1_1ElementView" id="r_a31d73ef3280d394c46a088ca5436958b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyft_1_1scope_1_1ElementView.html#a31d73ef3280d394c46a088ca5436958b">append</a> (self, *args, **kwargs)</td></tr>
 <tr class="separator:a31d73ef3280d394c46a088ca5436958b inherit pub_methods_classpyft_1_1scope_1_1ElementView"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a5bb9b80459f356d92d7b80ada4622a8a inherit pub_methods_classpyft_1_1scope_1_1ElementView" id="r_a5bb9b80459f356d92d7b80ada4622a8a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyft_1_1scope_1_1ElementView.html#a5bb9b80459f356d92d7b80ada4622a8a">extend</a> (self, *args, **kwargs)</td></tr>
@@ -377,6 +377,11 @@
 <tr class="separator:acc6e78ee53ab005264f7afacbb5bf821 inherit pub_attribs_classpyft_1_1scope_1_1PYFTscope"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a2a76eb1130ce3716d4631a7d49fdfaf9 inherit pub_attribs_classpyft_1_1scope_1_1PYFTscope" id="r_a2a76eb1130ce3716d4631a7d49fdfaf9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyft_1_1scope_1_1PYFTscope.html#a2a76eb1130ce3716d4631a7d49fdfaf9">path</a></td></tr>
 <tr class="separator:a2a76eb1130ce3716d4631a7d49fdfaf9 inherit pub_attribs_classpyft_1_1scope_1_1PYFTscope"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="inherit_header pub_attribs_classpyft_1_1scope_1_1ElementView"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classpyft_1_1scope_1_1ElementView')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classpyft_1_1scope_1_1ElementView.html">pyft.scope.ElementView</a></td></tr>
+<tr class="memitem:a073885b1ab1c4b783494dca605d6e3fe inherit pub_attribs_classpyft_1_1scope_1_1ElementView" id="r_a073885b1ab1c4b783494dca605d6e3fe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyft_1_1scope_1_1ElementView.html#a073885b1ab1c4b783494dca605d6e3fe">text</a></td></tr>
+<tr class="separator:a073885b1ab1c4b783494dca605d6e3fe inherit pub_attribs_classpyft_1_1scope_1_1ElementView"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a7f7353df8c6ddc69baf1e9b717ef23cb inherit pub_attribs_classpyft_1_1scope_1_1ElementView" id="r_a7f7353df8c6ddc69baf1e9b717ef23cb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyft_1_1scope_1_1ElementView.html#a7f7353df8c6ddc69baf1e9b717ef23cb">tail</a></td></tr>
+<tr class="separator:a7f7353df8c6ddc69baf1e9b717ef23cb inherit pub_attribs_classpyft_1_1scope_1_1ElementView"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="inherit_header pub_attribs_classpyft_1_1variables_1_1Variables"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classpyft_1_1variables_1_1Variables')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classpyft_1_1variables_1_1Variables.html">pyft.variables.Variables</a></td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>