Minor change in README (indicates the preference for python3 instead of py2).

98034e21 · hhakim · e8020553 · 98034e21 · 98034e21
Commit 98034e21 authored 4 years ago by hhakim
--- a/gen_doc/bin_pkgs/README_template.html
+++ b/gen_doc/bin_pkgs/README_template.html
 <!doctype html public "-//W3C//DTD HTML 4.0 Transitional //EN">
 <html>
 <head>
-  <meta name="GENERATOR" content="mkd2html 2.2.2">
+  <meta name="GENERATOR" content="mkd2html 2.2.4">
-  <meta http-equiv="Content-Type"
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-        content="text/html; charset=utf-8">  <title></title>
+  <title></title>
 </head>
 <body>
 <h1>Quick Guide to Install and Use the FAµST Wrappers</h1>
@@ -16,12 +16,14 @@
 <p><a href="#usage">4. Usage</a></p>
-<h2><a name="prerequisites">1. Prerequisites<a/></h2>
+<p>\anchor prerequisites</p>
+<h2>1. Prerequisites</h2>
 <h3>1.1 For Python</h3>
-<p>@note  This section treats only of system packages/installers but note that some pip packages are also available. You might install them in virtual environments:
+<p>@note  This section treats only of system packages/installers but note that some pip packages are also available and this is in fact the recommended way of installing pyfaust, in particular because of the easier weak dependency management. You might install them in virtual environments:
-\ref install_pyfaust_in_venv</p>
+\ref install_pyfaust_in_venv.<br/></p>
 <p>FAµST is designed for the Python ecosystem which as usual relies on the numpy and scipy packages.</p>
@@ -29,7 +31,7 @@
 <p>Please ensure these packages are installed on your system. One way to install them is to use the pip program delivered with your python version.</p>
-<pre><code>pip install numpy scipy matplotlib
+<pre><code>pip install numpy scipy matplotlib # pygsp
 # it could be pip3 instead of pip
 </code></pre>
@@ -38,20 +40,27 @@ Note also that you can rely on your system package manager to install the Python
 <p>FAµST supports at least Python 2.7.15 and is also compiled for Python @PY3_VER@.</p>
+<p>Note that starting from january 2020 python2.7 won&rsquo;t be supported anymore and FAµST newer packages won&rsquo;t deliver any python 2.7 wrapper too.
+Anyway, the python 3 versions are more advanced and it&rsquo;s highly recommended to move to these versions.</p>
 <p>If you want to use FAµST with Python 3 you must use precisely the @PY3_VER@ version because the FAµST Python wrapper delivered within the binary package is compiled for that version only.</p>
-<p>@note pygsp is an optional python package to install in order to generate graphs and their Laplacians for testing the FGFT algorithms added in FAµST 2.4.</p>
+<p>@note pygsp is an optional python package to install in order to generate graphs and their Laplacians for testing the FGFT/eigen decomposition algorithms.</p>
 <h3>1.2 For Matlab</h3>
 <p>The FAµST wrapper for Matlab has been tested on several Matlab versions starting from version 2016a,b up to version 2018a,b.<br/>
 However it&rsquo;s not totally excluded that FAµST works with older or newer versions.</p>
-<h2><a name="installation"> 2. Installation</a></h2>
+<p>\anchor installation</p>
+<h2>2. Installation</h2>
 <p>@OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS@</p>
-<h2><a name="installation_testing">3. Testing and Troubleshooting<a/></h2>
+<p>\anchor installation_testing</p>
+<h2>3. Testing and Troubleshooting</h2>
 <p>Normally, after installing, nothing is left to do. The installation process should have seamlessly set up the Faust wrappers for Python and Matlab into your environment.
 Nevertheless, it could be useful to check that it really worked and set the environment manually if needed like explained below.</p>
@@ -152,7 +161,9 @@ Otherwise it works but you&rsquo;ll need to set the `export' command manually in
 <p>OK! You can follow the <a href="#usage">quick start usage</a> now.</p>
-<h2><a name="usage">4. Usage<a/></h2>
+<p>\anchor usage</p>
+<h2>4. Usage</h2>
 <h3>4.1 Matlab Wrapper</h3>
@@ -166,7 +177,7 @@ Otherwise it works but you&rsquo;ll need to set the `export' command manually in
 <pre><code>&gt;&gt; rcg(A)
 &gt;&gt; density(A)
-&gt;&gt; get_num_factors(A)
+&gt;&gt; numfactors(A)
 </code></pre>
 <p>@note if you&rsquo;re wondering what are these functions just consult the inline doc:</p>
@@ -231,8 +242,8 @@ end quickstart.py
 0.15
 &gt;&gt;&gt; A.get_num_factors()
 2
-&gt;&gt;&gt; F1 = A.factors(0)
+&gt;&gt;&gt; F1 = A.get_factor(0)
-&gt;&gt;&gt; F2 = A.factors(1)
+&gt;&gt;&gt; F2 = A.get_factor(1)
 &gt;&gt;&gt; A.shape
 (1000L, 2000L)
 </code></pre>

--- a/gen_doc/bin_pkgs/README_template.md
+++ b/gen_doc/bin_pkgs/README_template.md
@@ -30,6 +30,9 @@ Note also that you can rely on your system package manager to install the Python
 FAµST supports at least Python 2.7.15 and is also compiled for Python @PY3_VER@.
+Note that starting from january 2020 python2.7 won't be supported anymore and FAµST newer packages won't deliver any python 2.7 wrapper too.
+Anyway, the python 3 versions are more advanced and it's highly recommended to move to these versions.
 If you want to use FAµST with Python 3 you must use precisely the @PY3_VER@ version because the FAµST Python wrapper delivered within the binary package is compiled for that version only.
 @note pygsp is an optional python package to install in order to generate graphs and their Laplacians for testing the FGFT/eigen decomposition algorithms.