Mentions légales du service

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

Update install guide doc (especially for matlab).

parent 8e880917
Branches
Tags 2.5.62rc23
No related merge requests found
Pipeline #833960 skipped
...@@ -69,7 +69,7 @@ Nevertheless, it could be useful to check that it really worked and set the envi ...@@ -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>To test whether the FAµST Matlab wrapper auto-setup succeeded at install stage, you can open a terminal and type:</p>
<pre><code>matlab -nodisplay -nojvm -r "import matfaust.FaustFactory;F = FaustFactory.rand(1, 10, .5, 'dense', 'complex'); F" <pre><code>matlab -nodisplay -nojvm -r "matfaust.rand(1, 10, .5, 'dense', 'complex')"
</code></pre> </code></pre>
<p>Note: if Matlab is not set in your PATH environment variable you need to replace `matlab' with its full path <p>Note: if Matlab is not set in your PATH environment variable you need to replace `matlab' with its full path
...@@ -91,9 +91,10 @@ Nevertheless, it could be useful to check that it really worked and set the envi ...@@ -91,9 +91,10 @@ Nevertheless, it could be useful to check that it really worked and set the envi
<p>Then launch the script that is responsible to add FAµST location in your Matlab path.</p> <p>Then launch the script that is responsible to add FAµST location in your Matlab path.</p>
<pre><code>&gt;&gt; setup_FAUST <pre><code>
&gt;&gt; setup_FAUST
&gt;&gt; % then test again FAµST &gt;&gt; % then test again FAµST
&gt;&gt; import matfaust.FaustFactory;F = FaustFactory.rand(1, 10, .5, 'dense', 'complex');disp(F);exit &gt;&gt; matfaust.rand(1, 10, .5, 'dense', 'complex')
</code></pre> </code></pre>
<p>For that change to be applied permanently, you need to automatize the `addpath()&lsquo; call made by setup_FAUST.<br/> <p>For that change to be applied permanently, you need to automatize the `addpath()&lsquo; call made by setup_FAUST.<br/>
...@@ -102,12 +103,17 @@ For that purpose:</p> ...@@ -102,12 +103,17 @@ For that purpose:</p>
<ol> <ol>
<li>Look into your matlab installation directory (e.g. on macOS /Applications/Matlab/MATLAB_R2018b.app/bin/matlab), next: <li>Look into your matlab installation directory (e.g. on macOS /Applications/Matlab/MATLAB_R2018b.app/bin/matlab), next:
<li>Go into the sub-directory toolbox/local <li>Go into the sub-directory toolbox/local
<li>Edit the file startup.m by adding the follwing line: <li>Edit the file startup.m by adding the following lines:
<pre> <pre>
addpath(genpath('@FAUST_INSTALL_PATH@/matlab')) oldpwd=pwd;
cd @FAUST_INSTALL_PATH@/matlab;
setup_FAUST
cd oldpwd;
</pre> </pre>
</ol> </ol>
Finally type <a href="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>Note: you can also edit a user specific startup.m script instead of system&rsquo;s startup.m. Look the Matlab documentation <a href="https://fr.mathworks.com/help/matlab/matlab_env/startup-options.html">here</a>.</p> <p>Note: you can also edit a user specific startup.m script instead of system&rsquo;s startup.m. Look the Matlab documentation <a href="https://fr.mathworks.com/help/matlab/matlab_env/startup-options.html">here</a>.</p>
......
...@@ -57,7 +57,7 @@ Nevertheless, it could be useful to check that it really worked and set the envi ...@@ -57,7 +57,7 @@ Nevertheless, it could be useful to check that it really worked and set the envi
To test whether the FAµST Matlab wrapper auto-setup succeeded at install stage, you can open a terminal and type: To test whether the FAµST Matlab wrapper auto-setup succeeded at install stage, you can open a terminal and type:
matlab -nodisplay -nojvm -r "import matfaust.FaustFactory;F = FaustFactory.rand(1, 10, .5, 'dense', 'complex'); F" matlab -nodisplay -nojvm -r "matfaust.rand(1, 10, .5, 'dense', 'complex')"
Note: if Matlab is not set in your PATH environment variable you need to replace `matlab' with its full path Note: if Matlab is not set in your PATH environment variable you need to replace `matlab' with its full path
(e.g. on macOS /Applications/Matlab/MATLAB_R2018b.app/bin/matlab) (e.g. on macOS /Applications/Matlab/MATLAB_R2018b.app/bin/matlab)
...@@ -66,7 +66,7 @@ It works only if you see an output similar to: ...@@ -66,7 +66,7 @@ It works only if you see an output similar to:
Faust size 10x10, density 0.50, nnz_sum 50, 1 factor(s): Faust size 10x10, density 0.50, nnz_sum 50, 1 factor(s):
- FACTOR 0 (complex) DENSE, size 10x10, density 0.5, nnz 50 - FACTOR 0 (complex) DENSE, size 10x10, density 0.5, nnz 50
>> % other values are possible for density, etc. because of the random generation % other values are possible for density, etc. because of the random generation
Otherwise it didn't work. So here is how to setup the wrapper manually. Otherwise it didn't work. So here is how to setup the wrapper manually.
...@@ -78,7 +78,7 @@ Then launch the script that is responsible to add FAµST location in your Matlab ...@@ -78,7 +78,7 @@ Then launch the script that is responsible to add FAµST location in your Matlab
>> setup_FAUST >> setup_FAUST
>> % then test again FAµST >> % then test again FAµST
>> import matfaust.FaustFactory;F = FaustFactory.rand(1, 10, .5, 'dense', 'complex');disp(F);exit >> matfaust.rand(1, 10, .5, 'dense', 'complex')
For that change to be applied permanently, you need to automatize the `addpath()' call made by setup_FAUST.<br/> For that change to be applied permanently, you need to automatize the `addpath()' call made by setup_FAUST.<br/>
For that purpose: For that purpose:
...@@ -86,12 +86,17 @@ For that purpose: ...@@ -86,12 +86,17 @@ For that purpose:
<ol> <ol>
<li>Look into your matlab installation directory (e.g. on macOS /Applications/Matlab/MATLAB_R2018b.app/bin/matlab), next: <li>Look into your matlab installation directory (e.g. on macOS /Applications/Matlab/MATLAB_R2018b.app/bin/matlab), next:
<li>Go into the sub-directory toolbox/local <li>Go into the sub-directory toolbox/local
<li>Edit the file startup.m by adding the follwing line: <li>Edit the file startup.m by adding the following lines:
<pre> <pre>
addpath(genpath('@FAUST_INSTALL_PATH@/matlab')) oldpwd=pwd;
cd @FAUST_INSTALL_PATH@/matlab; % for Windows users this is: C:\Program Files\faust\matlab
setup_FAUST
cd oldpwd;
</pre> </pre>
</ol> </ol>
Finally type <a href="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 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. OK! You can follow the [quick start usage](#usage) now.
......
...@@ -50,6 +50,7 @@ The static packages for this release are: ...@@ -50,6 +50,7 @@ The static packages for this release are:
</pre> </pre>
After installing the package, you'll need to restart your Matlab or Python session in order to take into account the new configuration of your environment. After installing the package, you'll need to restart your Matlab or Python session in order to take into account the new configuration of your environment.<br/>
If Faust is not found, see <a href="#installation_testing">below</a> then for troubleshooting.<br/>
...@@ -12,11 +12,9 @@ Alternatively, you can also proceed with the following command in a terminal: ...@@ -12,11 +12,9 @@ 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_R2018b.app /Applications <pre><code> $ sudo ln -sf /path/to/matlab/install/MATLAB/MATLAB_R2018b.app /Applications/MATLAB/ # creates the MATLAB folder if doesn't exit yet
</code></pre> </code></pre>
After installing the package, 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 languages you'll just need to relaunch the installer. After installing the package, 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 languages you'll just need to relaunch the installer.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment