Mentions légales du service

Skip to content
Snippets Groups Projects
Commit 638ab14c authored by hhakim's avatar hhakim
Browse files

Update/Correct system pkg installation guide.

parent a3fb0d1b
Branches
Tags 3.38.18
No related merge requests found
Pipeline #834161 skipped
Hide whitespace changes
Inline Side-by-side
gen_doc/bin_pkgs/README_template.html
+ 11
− 11
View file @ 638ab14c
...@@ -22,14 +22,14 @@ ...@@ -22,14 +22,14 @@
<h3>1.1 For Python</h3> <h3>1.1 For Python</h3>
<p>@note This section treats only of system packages/installers but note that some PIP and Anaconda packages are also available. They are recommended way of installing pyfaust, in particular because of the easier weak dependency management. You might install them in virtual environments: <p>@note This section treats only of system packages/installers but note that some PIP and Anaconda packages are also available. Installing those PIP packages is recommended, in particular because of the easier weak dependency management. You might install them in virtual environments:
\ref install_pyfaust_in_venv.<br/></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> <p>FAµST is designed for the Python ecosystem which as usual relies on the numpy and scipy packages.</p>
<p>If you want to run the FAµST demos (module pyfaust.demo), you&rsquo;ll also need the matplotlib package.</p> <p>If you want to run the FAµST demos (module pyfaust.demo), you&rsquo;ll also need the matplotlib package.</p>
<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> <p>Please ensure these packages are installed on your system. One way to proceed is to use the pip program delivered with your python version.</p>
<pre><code>pip install numpy scipy matplotlib # pygsp <pre><code>pip install numpy scipy matplotlib # pygsp
# it could be pip3 instead of pip # it could be pip3 instead of pip
...@@ -46,8 +46,8 @@ Note also that you can rely on your system package manager to install the Python ...@@ -46,8 +46,8 @@ Note also that you can rely on your system package manager to install the Python
<h3>1.2 For Matlab</h3> <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/> <p>The FAµST wrapper for Matlab has been tested on several Matlab versions starting from version 2016a,b up to version 2022b.<br/>
However it&rsquo;s not totally excluded that FAµST works with older or newer versions.</p> However it&rsquo;s not totally excluded that FAµST works with older and moreover newer versions.</p>
<p>\anchor installation</p> <p>\anchor installation</p>
...@@ -228,11 +228,11 @@ Otherwise it works but you&rsquo;ll need to set the `export' command manually in ...@@ -228,11 +228,11 @@ Otherwise it works but you&rsquo;ll need to set the `export' command manually in
<p>N.B.: to access the documentation, you need to be in the graphical interface of Matlab.</p> <p>N.B.: to access the documentation, you need to be in the graphical interface of Matlab.</p>
<p>Note that the doxygen documentation for the Matlab API is also available locally after installing Faust. You can consult it from your web browser: <a href="@API_DOC_BASE_URL@/html/namespacematfaust.html">namespacematfaust.html</a>.</p> <p>Note that the doxygen documentation for the Matlab API is also available locally after installing Faust (in the installation folder). You can consult it online: <a href="@API_DOC_BASE_URL@/html/namespacematfaust.html">namespacematfaust.html</a>.</p>
<h3>4.2 Python Wrapper</h3> <h3>4.2 Python Wrapper</h3>
<p>In the same spirit than the Matlab tutorial showed in the previous section, you can execute the quick start script for Python.</p> <p>In the same spirit as the Matlab tutorial showed in the previous section, you can execute the quick start script for Python.</p>
<pre><code>$ python3 -c "from pyfaust.demo import quickstart; quickstart.run()" <pre><code>$ python3 -c "from pyfaust.demo import quickstart; quickstart.run()"
dimension of the Faust : (1000, 2000) dimension of the Faust : (1000, 2000)
...@@ -255,14 +255,14 @@ end quickstart.py ...@@ -255,14 +255,14 @@ end quickstart.py
6.666666666666667 6.666666666666667
&gt;&gt;&gt; A.density() &gt;&gt;&gt; A.density()
0.15 0.15
&gt;&gt;&gt; A.get_num_factors() &gt;&gt;&gt; A.numfactors()
2 2
&gt;&gt;&gt; F1 = A.get_factor(0) &gt;&gt;&gt; F1 = A.factors(0)
&gt;&gt;&gt; F2 = A.get_factor(1) &gt;&gt;&gt; F2 = A.factors(1)
&gt;&gt;&gt; A.shape &gt;&gt;&gt; A.shape
(1000L, 2000L) (1000, 2000)
</code></pre> </code></pre>
<p>Note that the doxygen documentation for the Python API is also available locally after installing Faust. You can consult it from your web browser: <a href="@API_DOC_BASE_URL@/html/namespacepyfaust.html">namespacepyfaust.html</a>.</p> <p>Note that the doxygen documentation for the Python API is also available locally after installing Faust (in the installation folder). You can consult it online: <a href="@API_DOC_BASE_URL@/html/namespacepyfaust.html">namespacepyfaust.html</a>.</p>
</body> </body>
</html> </html>
gen_doc/bin_pkgs/README_template.md
+ 11
− 11
View file @ 638ab14c
...@@ -13,14 +13,14 @@ ...@@ -13,14 +13,14 @@
### 1.1 For Python ### 1.1 For Python
@note This section treats only of system packages/installers but note that some PIP and Anaconda packages are also available. They are recommended way of installing pyfaust, in particular because of the easier weak dependency management. You might install them in virtual environments: @note This section treats only of system packages/installers but note that some PIP and Anaconda packages are also available. Installing those PIP packages is recommended, in particular because of the easier weak dependency management. You might install them in virtual environments:
\ref install_pyfaust_in_venv.<br/> \ref install_pyfaust_in_venv.<br/>
FAµST is designed for the Python ecosystem which as usual relies on the numpy and scipy packages. FAµST is designed for the Python ecosystem which as usual relies on the numpy and scipy packages.
If you want to run the FAµST demos (module pyfaust.demo), you'll also need the matplotlib package. If you want to run the FAµST demos (module pyfaust.demo), you'll also need the matplotlib package.
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. Please ensure these packages are installed on your system. One way to proceed is to use the pip program delivered with your python version.
pip install numpy scipy matplotlib # pygsp pip install numpy scipy matplotlib # pygsp
# it could be pip3 instead of pip # it could be pip3 instead of pip
...@@ -36,8 +36,8 @@ If you want to use FAµST with Python 3 you must use precisely the @PY3_VER@ ver ...@@ -36,8 +36,8 @@ If you want to use FAµST with Python 3 you must use precisely the @PY3_VER@ ver
### 1.2 For Matlab ### 1.2 For Matlab
The FAµST wrapper for Matlab has been tested on several Matlab versions starting from version 2016a,b up to version 2018a,b.<br/> The FAµST wrapper for Matlab has been tested on several Matlab versions starting from version 2016a,b up to version 2022b.<br/>
However it's not totally excluded that FAµST works with older or newer versions. However it's not totally excluded that FAµST works with older and moreover newer versions.
\anchor installation \anchor installation
## 2. Installation ## 2. Installation
...@@ -197,11 +197,11 @@ For more information on the FAµST API, and a whole function listing, consult th ...@@ -197,11 +197,11 @@ For more information on the FAµST API, and a whole function listing, consult th
N.B.: to access the documentation, you need to be in the graphical interface of Matlab. N.B.: to access the documentation, you need to be in the graphical interface of Matlab.
Note that the doxygen documentation for the Matlab API is also available locally after installing Faust. You can consult it from your web browser: [namespacematfaust.html](@API_DOC_BASE_URL@/html/namespacematfaust.html). Note that the doxygen documentation for the Matlab API is also available locally after installing Faust (in the installation folder). You can consult it online: [namespacematfaust.html](@API_DOC_BASE_URL@/html/namespacematfaust.html).
### 4.2 Python Wrapper ### 4.2 Python Wrapper
In the same spirit than the Matlab tutorial showed in the previous section, you can execute the quick start script for Python. In the same spirit as the Matlab tutorial showed in the previous section, you can execute the quick start script for Python.
$ python3 -c "from pyfaust.demo import quickstart; quickstart.run()" $ python3 -c "from pyfaust.demo import quickstart; quickstart.run()"
dimension of the Faust : (1000, 2000) dimension of the Faust : (1000, 2000)
...@@ -224,14 +224,14 @@ You can also go through the Python terminal to build a FAµST product and call i ...@@ -224,14 +224,14 @@ You can also go through the Python terminal to build a FAµST product and call i
6.666666666666667 6.666666666666667
>>> A.density() >>> A.density()
0.15 0.15
>>> A.get_num_factors() >>> A.numfactors()
2 2
>>> F1 = A.get_factor(0) >>> F1 = A.factors(0)
>>> F2 = A.get_factor(1) >>> F2 = A.factors(1)
>>> A.shape >>> A.shape
(1000L, 2000L) (1000, 2000)
Note that the doxygen documentation for the Python API is also available locally after installing Faust. You can consult it from your web browser: [namespacepyfaust.html](@API_DOC_BASE_URL@/html/namespacepyfaust.html). Note that the doxygen documentation for the Python API is also available locally after installing Faust (in the installation folder). You can consult it online: [namespacepyfaust.html](@API_DOC_BASE_URL@/html/namespacepyfaust.html).
gen_doc/bin_pkgs/linux/README_install_part.html
+ 1
− 1
View file @ 638ab14c
...@@ -41,7 +41,7 @@ On Ubuntu or Debian: ...@@ -41,7 +41,7 @@ On Ubuntu or Debian:
Other alternative, especially for old versions of distributions, not updated anymore like Fedora 24, is to install the static version of FAµST package. Other alternative, especially for old versions of distributions, not updated anymore like Fedora 24, is to install the static version of FAµST package.
It's needed because you could be stuck with a too much old version of matio. It's needed because you could be stuck with a too much old version of matio.
The adjective static means that matio library and its own dependencies are statically linked/integrated into the package binaries so you're free to install the package without installing matio. The adjective static means that matio library and its own dependencies are statically linked/integrated into the package binaries so you're free to install the package without installing matio.
However it's not recommended to use this approach if you're system provides a sufficiently recent version of matio (>= 1.5.7). However it's not recommended to use this approach if you're system provides a sufficiently recent version of matio (>= 1.5.7, >= 1.5.23 is recommended).
<br/><br/> <br/><br/>
The static packages for this release are: The static packages for this release are:
<br/> <br/>
......
gen_doc/bin_pkgs/macosx/README_install_part.html
+ 2
− 2
View file @ 638ab14c
...@@ -12,7 +12,7 @@ Alternatively, you can also proceed with the following command in a terminal: ...@@ -12,7 +12,7 @@ Alternatively, you can also proceed with the following command in a terminal:
Likewise, if Matlab has not been installed in its default path, then it's most likely the auto-setup script won't find it, see <a href="#installation_testing">below</a> then for troubleshooting.<br/> Likewise, if Matlab has not been installed in its default path, then it's most likely the auto-setup script won't find it, see <a href="#installation_testing">below</a> then for troubleshooting.<br/>
To avoid this issue you can <i>symlink</i> you matlab path into /Applications (the default path) as it follows: To avoid this issue you can <i>symlink</i> you matlab path into /Applications (the default path) as it follows:
<pre><code> $ sudo ln -sf /path/to/matlab/install/MATLAB/MATLAB_R2018b.app /Applications/MATLAB/ # creates the MATLAB folder if doesn't exit yet <pre><code> $ sudo ln -sf /path/to/matlab/install/MATLAB/MATLAB_R2018b.app /Applications/MATLAB/ # you have to create the MATLAB folder if it doesn't exist yet
</code></pre> </code></pre>
...@@ -22,6 +22,6 @@ To avoid this issue you can <i>symlink</i> you matlab path into /Applications (t ...@@ -22,6 +22,6 @@ To avoid this issue you can <i>symlink</i> you matlab path into /Applications (t
you'll need to restart your Matlab or Python session in order to take into account the new configuration of your environment. Of course if you want to use only the Python wrapper you don't need to worry about setting the PATH environment for Matlab and conversely. But note that if later you change your mind and want FAµST for the both platforms you'll just need to relaunch the installer. you'll need to restart your Matlab or Python session in order to take into account the new configuration of your environment. Of course if you want to use only the Python wrapper you don't need to worry about setting the PATH environment for Matlab and conversely. But note that if later you change your mind and want FAµST for the both platforms you'll just need to relaunch the installer.
</li> </li>
<li> <li>
On Mac OS X you might need to install OpenMP for pyfaust to work, for further information please look at this <a href="https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/FAQ.html#py_four">FAQ entry</a>. On Mac OS X you might need to install OpenMP for pyfaust to work, for further information please look at this <a href="https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/FAQ.html#py_four">FAQ entry</a>. It was actually a need of older versions of FAµST, in recent ones OpenMP is delivered with the pyfaust package itself.
</li> </li>
</ul> </ul>
gen_doc/bin_pkgs/win/README_install_part.html
+ 1
− 1
View file @ 638ab14c
...@@ -13,7 +13,7 @@ Alternatively, you can also proceed with the following command in a cmd.exe prom ...@@ -13,7 +13,7 @@ Alternatively, you can also proceed with the following command in a cmd.exe prom
</code></pre> </code></pre>
<b>WARNING:</b> For the installation process to succeed you should have Matlab <b>WARNING:</b> For the installation process to succeed you should have Matlab
and Python (relevant version) set in your PATH environment variable (you can and Python (relevant versions) set in your PATH environment variable (you can
update it in Windows parameters). Of course if you want to use only the Python update it in Windows parameters). Of course if you want to use only the Python
wrapper you don't need to worry about setting the PATH environment for Matlab wrapper you don't need to worry about setting the PATH environment for Matlab
and conversely. However the installer tries to install pyfaust and matfaust in and conversely. However the installer tries to install pyfaust and matfaust in
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment