<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:
<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:
\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>
...
...
@@ -35,10 +35,10 @@
# it could be pip3 instead of pip
</code></pre>
<p>Note that you probably have to install those packages for all versions of Python you want to use (each one have normally its associated pip executable).<br/>
<p>Note that you probably have to install those packages for all versions of Python you want to use (each one has normally its associated pip executable).<br/>
Note also that you can rely on your system package manager to install the Python packages (e.g. dnf/yum repositories on Fedora/Centos Linux systems).</p>
<p>FAµST supports at least Python 2.7.15 and is also compiled for Python @PY3_VER@.</p>
<p>FAµST is compiled for Python @PY3_VER@.</p>
<p>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.</p>
...
...
@@ -69,7 +69,7 @@ Nevertheless, it could be useful to check that it really worked and set the envi
<p>To test whether the FAµST Matlab wrapper auto-setup succeeded at install stage, you can open a terminal and type:</p>
<p>For that change to be applied permanently, you need to automatize the `addpath()‘ call made by setup_FAUST.<br/>
<h3>3.1.1 Permament path using savepath</h3>
<p>Once matfaust path has been loaded into matlab environment you can save the
configuration for future uses by simply typing:</p>
<pre><code>>> savepath
</code></pre>
<p>The next time you’ll run Matlab the matfaust package will be directly
available.</p>
<h3>3.1.2 Permanent path using Matlab’s startup.m</h3>
<p>Another way for that change of matlab path to be applied permanently, is to automatize the `addpath()‘ call made by <code>setup_FAUST</code>.<br/>
For that purpose:</p>
<ol>
...
...
@@ -106,16 +118,16 @@ For that purpose:</p>
<li>Edit the file startup.m by adding the following lines:
<pre>
oldpwd=pwd;
cd @FAUST_INSTALL_PATH@/matlab;
cd @FAUST_INSTALL_PATH@/matlab; % for Windows users this is: C:\Program Files\faust\matlab
setup_FAUST
cd oldpwd;
</pre>
</ol>
Finally type <ahref="https://fr.mathworks.com/help/matlab/ref/rehash.html#d120e1067468">`rehash toolbox'</a> in your current matlab terminal and restart Matlab in order to verify the configuration is permanent.
<p>Finally type <ahref="https://fr.mathworks.com/help/matlab/ref/rehash.html#d120e1067468">`rehash toolbox'</a> in your current matlab terminal and restart Matlab in order to verify the configuration is permanent.</p>
<p>Note: you can also edit a user specific startup.m script instead of system’s startup.m. Look the Matlab documentation <ahref="https://fr.mathworks.com/help/matlab/matlab_env/startup-options.html">here</a>.</p>
<p>Note: you can also edit a user’s specific startup.m script instead of system’s startup.m. Look the Matlab documentation <ahref="https://fr.mathworks.com/help/matlab/matlab_env/startup-options.html">here</a>.</p>
<p>OK! You can follow the <ahref="#usage">quick start usage</a> now.</p>
...
...
@@ -123,9 +135,9 @@ Finally type <a href="https://fr.mathworks.com/help/matlab/ref/rehash.html#d120e
<p>To test whether the FaµST Python wrapper has been setup properly, simply open a terminal and type:</p>
For that change to be applied permanently, you need to automatize the `addpath()' call made by setup_FAUST.<br/>
### 3.1.1 Permament path using savepath
Once matfaust path has been loaded into matlab environment you can save the
configuration for future uses by simply typing:
>> savepath
The next time you'll run Matlab the matfaust package will be directly
available.
### 3.1.2 Permanent path using Matlab's startup.m
Another way for that change of matlab path to be applied permanently, is to automatize the `addpath()' call made by ``setup_FAUST``.<br/>
For that purpose:
<ol>
...
...
@@ -97,7 +109,7 @@ For that purpose:
Finally type <ahref="https://fr.mathworks.com/help/matlab/ref/rehash.html#d120e1067468">`rehash toolbox'</a> in your current matlab terminal and restart Matlab in order to verify the configuration is permanent.
Note: you can also edit a user specific startup.m script instead of system's startup.m. Look the Matlab documentation [here](https://fr.mathworks.com/help/matlab/matlab_env/startup-options.html).
Note: you can also edit a user's specific startup.m script instead of system's startup.m. Look the Matlab documentation [here](https://fr.mathworks.com/help/matlab/matlab_env/startup-options.html).
OK! You can follow the [quick start usage](#usage) now.