Mentions légales du service

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

Add a Windows sub-section in installation section of the quick start guide.

parent 2969c461
No related branches found
No related tags found
No related merge requests found
......@@ -44,7 +44,9 @@ if(BUILD_DOCUMENTATION)
file(READ ${PROJECT_BINARY_DIR}/doc/README_install_part.html OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS1)
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/linux/README_install_part.html ${PROJECT_BINARY_DIR}/doc/README_install_part.html)
file(READ ${PROJECT_BINARY_DIR}/doc/README_install_part.html OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS2)
string(CONCAT OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS ${OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS1} ${OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS2})
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/win/README_install_part.html ${PROJECT_BINARY_DIR}/doc/README_install_part.html)
file(READ ${PROJECT_BINARY_DIR}/doc/README_install_part.html OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS3)
string(CONCAT OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS ${OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS1} ${OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS2} ${OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS3})
endif()
if(APPLE)
......@@ -63,7 +65,13 @@ if(BUILD_DOCUMENTATION)
file(READ ${PROJECT_BINARY_DIR}/doc/README_install_part.html OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS)
endif()
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/README_template.html ${PROJECT_BINARY_DIR}/doc/html/README.html @ONLY)
#elif(WIN32) #TODO
elseif(WIN32)
if(NOT DEFINED OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS)
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/win/README_install_part.html ${PROJECT_BINARY_DIR}/doc/README_install_part.html)
file(READ ${PROJECT_BINARY_DIR}/doc/README_install_part.html OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS)
endif()
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/README_template.html ${PROJECT_BINARY_DIR}/doc/html/README.html @ONLY)
endif()
file(REMOVE ${PROJECT_BINARY_DIR}/doc/README_install_part.html)
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/README_template.md ${PROJECT_BINARY_DIR}/doc/README.md)
......
......@@ -20,6 +20,8 @@
<h3>1.1 For Python</h3>
<p>@note this section is intended to describe installation of the FAµST Python wrapper only from system packages/installers but note that some pip packages are also available.</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 de FAµST demos (module pyfaust.demo), you&rsquo;ll also need the matplotlib package.</p>
......@@ -219,7 +221,7 @@ end quickstart.py
<pre><code>$ python2.7
&gt;&gt;&gt; import pyfaust
&gt;&gt;&gt; A = pyfaust.Faust(filepath='@CMAKE_INSTALL_PREFIX@/python/A.mat') # A is the FAµST created through quickstart script
&gt;&gt;&gt; A = pyfaust.Faust(filepath='A.mat') # A is the FAµST created through quickstart script
&gt;&gt;&gt; A.rcg()
6.666666666666667
&gt;&gt;&gt; A.density()
......
......@@ -12,6 +12,8 @@
### 1.1 For Python
@note this section is intended to describe installation of the FAµST Python wrapper only from system packages/installers but note that some pip packages are also available.
FAµST is designed for the Python ecosystem which as usual relies on the numpy and scipy packages.
If you want to run de FAµST demos (module pyfaust.demo), you'll also need the matplotlib package.
......@@ -194,7 +196,7 @@ You can also go through the Python terminal to build a FAµST product and call i
$ python2.7
>>> import pyfaust
>>> A = pyfaust.Faust(filepath='@CMAKE_INSTALL_PREFIX@/python/A.mat') # A is the FAµST created through quickstart script
>>> A = pyfaust.Faust(filepath='A.mat') # A is the FAµST created through quickstart script
>>> A.rcg()
6.666666666666667
>>> A.density()
......
<a name="installation"><h2> Installation on Windows </h2></a>
You can just double-click the .exe file to launch the installation process.
You may need to authorize the installation onto the windows panel opened just after clicking.
That may require you to run the installer as Administrator user, doing it by right clicking and choosing "Run As".<br/>
Alternatively, you can also proceed with the following command in a cmd.exe prompt:
<pre><code> C:\\> runas /user:administrator \\path\\to\\faust-*.exe
:: with administrator being the name of an account with Administrator rights
</code></pre>
<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 update it in Windows parameters).
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.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment