Mentions légales du service

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

Include licenses and README in MacOSX packages and doc directory at installation stage.

parent 9fb1f229
Branches
Tags
No related merge requests found
Expand all Hide whitespace changes
Inline Side-by-side
.gitlab-ci.yml
+ 8
− 5
View file @ 65b16b8d
......@@ -59,7 +59,7 @@ package_macos:
stage: package_rev
script:
- if [[ ! -d 'build' ]]; then mkdir build;fi; cd build
- 'cmake -DBUILD_WRAPPER_PYTHON=ON -DBUILD_WRAPPER_MATLAB=ON -DBUILD_DOCUMENTATION=ON -DCMAKE_INSTALL_PREFIX=/opt/local/faust-$CI_COMMIT_SHA ..'
- 'cmake -DBUILD_WRAPPER_PYTHON=ON -DBUILD_WRAPPER_MATLAB=ON -DBUILD_DOCUMENTATION=ON -DCPACK_PACKAGE_VERSION=$CI_COMMIT_SHA -DCMAKE_INSTALL_PREFIX=/opt/local/faust-$CI_COMMIT_SHA ..'
- make
- 'echo $MACOS_PASS | sudo -S make install'
- 'echo $MACOS_PASS | sudo -S hdiutil create -volname Faust-$CI_COMMIT_SHA-MatlabR2016a-Py2.7 -srcfolder /opt/local/faust-$CI_COMMIT_SHA -ov -format UDRW faust-$CI_COMMIT_SHA'
......@@ -67,7 +67,8 @@ package_macos:
- for FILE in $(find /usr/local/lib ! -iname "libmatio*" -maxdepth 1 -mindepth 1); do filter_list+="--filter $(basename $FILE) "; done;
- pkgbuild --identifier fr.inria.faust.matio --version 1.5.12 --root /usr/local/lib $filter_list --install-location /usr/local/lib ./matio-bin-1.5.12.pkg
- productbuild --synthesize --package ./matio-bin-1.5.12.pkg --package faust-$CI_COMMIT_SHA.pkg ./distribution.plist
- productbuild --distribution ./distribution.plist --package-path . ./faust-matio-$CI_COMMIT_SHA.pkg
- sed -e 's/\(.*pkg-ref id=.fr.inria.faust".*\)/\1<title>FAµST '$CI_COMMIT_SHA'<\/title><license file="licenses.html"\/><readme file="installer_readme.html"\/>/' distribution.plist > tmp.plist; mv tmp.plist distribution.plist
- productbuild --distribution ./distribution.plist --package-path . --resources doc ./faust-matio-$CI_COMMIT_SHA.pkg
- mv ./faust-matio-$CI_COMMIT_SHA.pkg ./faust-$CI_COMMIT_SHA.pkg
- if [[ -d $MACOS_PKG_STORE_PATH ]]; then echo $MACOS_PASS | sudo -S mv faust-$CI_COMMIT_SHA.dmg faust-$CI_COMMIT_SHA.pkg $MACOS_PKG_STORE_PATH; fi
tags:
......@@ -92,12 +93,13 @@ package_linux:
- schedules
- tags
# jobs triggered by git tag don't verify that CMakeLists.txt conforms to the tag name/version but it must use the same version
# jobs triggered by git tag can force cpack to use the tag name as version but it's not necessary for MacOSX (not using cpack for that sys.)
# it's done for linux packages
package_macos_release:
script:
- if [[ ! -d 'build' ]]; then mkdir build;fi; cd build
- 'cmake -DBUILD_WRAPPER_PYTHON=ON -DBUILD_WRAPPER_MATLAB=ON -DBUILD_DOCUMENTATION=ON -DCMAKE_INSTALL_PREFIX=/opt/local/faust-$CI_COMMIT_TAG -DCMAKE_BUILD_TYPE=Release -DEXCLUDE_FAUST_LIB_INSTALL=ON ..'
- 'cmake -DBUILD_WRAPPER_PYTHON=ON -DBUILD_WRAPPER_MATLAB=ON -DBUILD_DOCUMENTATION=ON -DCMAKE_INSTALL_PREFIX=/opt/local/faust-$CI_COMMIT_TAG -DCPACK_PACKAGE_VERSION=$CI_COMMIT_TAG -DCMAKE_BUILD_TYPE=Release -DEXCLUDE_FAUST_LIB_INSTALL=ON ..'
- make
- 'echo $MACOS_PASS | sudo -S make install'
- 'echo $MACOS_PASS | sudo -S hdiutil create -volname Faust-$CI_COMMIT_TAG-MatlabR2016a-Py2.7 -srcfolder /opt/local/faust-$CI_COMMIT_TAG -ov -format UDRW faust-$CI_COMMIT_TAG'
......@@ -105,7 +107,8 @@ package_macos_release:
- for FILE in $(find /usr/local/lib ! -iname "libmatio*" -maxdepth 1 -mindepth 1); do filter_list+="--filter $(basename $FILE) "; done;
- pkgbuild --identifier fr.inria.faust.matio --version 1.5.12 --root /usr/local/lib $filter_list --install-location /usr/local/lib ./matio-bin-1.5.12.pkg
- productbuild --synthesize --package ./matio-bin-1.5.12.pkg --package faust-$CI_COMMIT_TAG.pkg ./distribution.plist
- productbuild --distribution ./distribution.plist --package-path . ./faust-matio-$CI_COMMIT_TAG.pkg
- sed -e 's/\(.*pkg-ref id=.fr.inria.faust".*\)/\1<title>FAµST '$CI_COMMIT_TAG'<\/title><license file="licenses.html"\/><readme file="installer_readme.html"\/>/' distribution.plist > tmp.plist; mv tmp.plist distribution.plist
- productbuild --distribution ./distribution.plist --package-path . --resources doc ./faust-matio-$CI_COMMIT_TAG.pkg
- mv ./faust-matio-$CI_COMMIT_TAG.pkg ./faust-$CI_COMMIT_TAG.pkg
- if [[ -d $MACOS_PKG_STORE_PATH ]]; then echo $MACOS_PASS | sudo -S mv faust-$CI_COMMIT_TAG.dmg faust-$CI_COMMIT_TAG.pkg $MACOS_PKG_STORE_PATH; fi
tags:
......
CMakeLists.txt
+ 2
− 1
View file @ 65b16b8d
......@@ -711,12 +711,13 @@ if(${BUILD_DOCUMENTATION})
# CMAKE_INSTALL_PREFIX is not set
string(REGEX REPLACE "(.*)/lib/?.*" "\\1/share/faust/doc" DOC_INSTALL_PREFIX ${FAUST_INSTALL_LIB})
endif()
install(FILES ${PROJECT_SOURCE_DIR}/license.txt ${PROJECT_SOURCE_DIR}/license_matio.txt DESTINATION ${DOC_INSTALL_PREFIX})
if(NOT ${EXCLUDE_FAUST_LIB_INSTALL})
install(DIRECTORY "${PROJECT_BINARY_DIR}/doc/html" DESTINATION "${DOC_INSTALL_PREFIX}")
else()
if(${BUILD_WRAPPER_PYTHON})
install(DIRECTORY "${PROJECT_BINARY_DIR}/doc/html" DESTINATION
${DOC_INSTALL_PREFIX} FILES_MATCHING PATTERN "classFaustPy*" PATTERN "FaustPy*")
${DOC_INSTALL_PREFIX} FILES_MATCHING PATTERN "classFaustPy*" PATTERN "FaustPy*" PATTERN "README.html")
endif()
if(${BUILD_WRAPPER_MATLAB})
# TODO:
......
gen_doc/CMakeLists.txt
+ 8
− 0
View file @ 65b16b8d
......@@ -20,6 +20,14 @@ if(BUILD_DOCUMENTATION)
else()
message(WARNING "Doxygen not found, cannot generate the documentation")
endif(DOXYGEN_FOUND)
if(APPLE)
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/macosx/installer_readme.html.in ${PROJECT_BINARY_DIR}/doc/installer_readme.html @ONLY)
file(COPY ${FAUST_DOC_SRC_DIR}/bin_pkgs/macosx/licenses.html DESTINATION ${PROJECT_BINARY_DIR}/doc/)
file(COPY ${FAUST_DOC_SRC_DIR}/bin_pkgs/macosx/README.html DESTINATION ${PROJECT_BINARY_DIR}/doc/html/)
elseif(UNIX)
file(COPY ${FAUST_DOC_SRC_DIR}/bin_pkgs/linux/README.html DESTINATION ${PROJECT_BINARY_DIR}/doc/html/)
endif()
endif(BUILD_DOCUMENTATION)
......
gen_doc/bin_pkgs/linux/README.html 0 → 100644
+ 97
− 0
View file @ 65b16b8d
<!doctype html public "-//W3C//DTD HTML 4.0 Transitional //EN">
<html>
<head>
<meta name="GENERATOR" content="mkd2html 2.2.2">
<meta http-equiv="Content-Type"
content="text/html; charset=utf-8"> <title></title>
</head>
<body>
<h1>Quick Guide to Install and Use FAuST Wrappers</h1>
<h2>Installation</h2>
<p>TODO</p>
<h2>Setup and Usage</h2>
<h3>Matlab Wrapper</h3>
<p>After installing the FAuST package, it&rsquo;s straight forward, in a terminal type:</p>
<pre><code> $ cd /opt/local/faust-*/matlab
$ matlab -nodisplay
</code></pre>
<p>Here you are in Matlab terminal. Note that you can also do it through Matlab GUI.</p>
<p>The following script will add FAuST in your PATH. This is needed for Matlab to use FAuST.</p>
<pre><code> &gt;&gt; setup_FAUST
</code></pre>
<p>Now let&rsquo;s test FAuST with the quickstart script:</p>
<pre><code> &gt;&gt; quick_start
</code></pre>
<p>And then type further instructions to test a bit of FAuST API:</p>
<p>Let&rsquo;s see what variables quickstart script has added.</p>
<pre><code> &gt;&gt; whos
</code></pre>
<p>Now call some functions on FAuST object A:</p>
<pre><code> &gt;&gt; RCG(A)
&gt;&gt; density(A)
&gt;&gt; get_nb_factor(A)
</code></pre>
<p>Retrieve the product factors (as full matrices):</p>
<pre><code> &gt;&gt; F1 = get_fact(A,1);
&gt;&gt; F2 = get_fact(A,2);
</code></pre>
<p>Check the sizes:</p>
<pre><code> &gt;&gt; size(F1)
&gt;&gt; size(F2)
&gt;&gt; size(A)
</code></pre>
<p>For more information on FAuST API, and whole function listing, consult the doc:</p>
<pre><code> &gt;&gt; doc('Faust')
</code></pre>
<p>N.B.: to access the documentation, you need to be in the graphical interface of matlab.</p>
<h3>Python Wrapper</h3>
<p>In the same idea, the python wrapper of FAuST is usable going into its directory.</p>
<pre><code> $ cd /opt/local/faust-*/python
$ python2.7 quickstart.py
</code></pre>
<p>You can also go through python terminal to build a FAuST product and call its object methods.</p>
<pre><code> $ python2.7
&gt;&gt;&gt; import FaustPy
&gt;&gt;&gt; import FaustPy
&gt;&gt;&gt; A = FaustPy.Faust('A.mat') # A is the FAuST created through quickstart script
&gt;&gt;&gt; A.RCG()
6.666666666666667
&gt;&gt;&gt; A.density()
0.15
&gt;&gt;&gt; A.get_nb_factors()
2
&gt;&gt;&gt; F1 = A.get_factor(0)
&gt;&gt;&gt; F2 = A.get_factor(1)
&gt;&gt;&gt; A.size()
(1000, 2000)
</code></pre>
</body>
</html>
gen_doc/bin_pkgs/macosx/README.html 0 → 100644
+ 103
− 0
View file @ 65b16b8d
<!doctype html public "-//W3C//DTD HTML 4.0 Transitional //EN">
<html>
<head>
<meta name="GENERATOR" content="mkd2html 2.2.2">
<meta http-equiv="Content-Type"
content="text/html; charset=utf-8"> <title></title>
</head>
<body>
<h1>Quick Guide to Install and Use FAuST Wrappers</h1>
<h2>Installation</h2>
<p>You can just double-click the .pkg file to launch the installation process.
Maybe you&rsquo;ll need to authorize a non-appstore app installation into preferences/security parameters.</p>
<p>You can also proceed with the following command in a terminal:</p>
<pre><code>$ sudo installer -pkg /path/to/faust-*.pkg -target /
</code></pre>
<h2>Setup and Usage</h2>
<h3>Matlab Wrapper</h3>
<p>After installing the FAuST package, it&rsquo;s straight forward, in a terminal type:</p>
<pre><code> $ cd /opt/local/faust-*/matlab
$ matlab -nodisplay
</code></pre>
<p>Here you are in Matlab terminal. Note that you can also do it through Matlab GUI.</p>
<p>The following script will add FAuST in your PATH. This is needed for Matlab to use FAuST.</p>
<pre><code> &gt;&gt; setup_FAUST
</code></pre>
<p>Now let&rsquo;s test FAuST with the quickstart script:</p>
<pre><code> &gt;&gt; quick_start
</code></pre>
<p>And then type further instructions to test a bit of FAuST API:</p>
<p>Let&rsquo;s see what variables quickstart script has added.</p>
<pre><code> &gt;&gt; whos
</code></pre>
<p>Now call some functions on FAuST object A:</p>
<pre><code> &gt;&gt; RCG(A)
&gt;&gt; density(A)
&gt;&gt; get_nb_factor(A)
</code></pre>
<p>Retrieve the product factors (as full matrices):</p>
<pre><code> &gt;&gt; F1 = get_fact(A,1);
&gt;&gt; F2 = get_fact(A,2);
</code></pre>
<p>Check the sizes:</p>
<pre><code> &gt;&gt; size(F1)
&gt;&gt; size(F2)
&gt;&gt; size(A)
</code></pre>
<p>For more information on FAuST API, and whole function listing, consult the doc:</p>
<pre><code> &gt;&gt; doc('Faust')
</code></pre>
<p>N.B.: to access the documentation, you need to be in the graphical interface of matlab.</p>
<h3>Python Wrapper</h3>
<p>In the same idea, the python wrapper of FAuST is usable going into its directory.</p>
<pre><code> $ cd /opt/local/faust-*/python
$ python2.7 quickstart.py
</code></pre>
<p>You can also go through python terminal to build a FAuST product and call its object methods.</p>
<pre><code> $ python2.7
&gt;&gt;&gt; import FaustPy
&gt;&gt;&gt; import FaustPy
&gt;&gt;&gt; A = FaustPy.Faust('A.mat') # A is the FAuST created through quickstart script
&gt;&gt;&gt; A.RCG()
6.666666666666667
&gt;&gt;&gt; A.density()
0.15
&gt;&gt;&gt; A.get_nb_factors()
2
&gt;&gt;&gt; F1 = A.get_factor(0)
&gt;&gt;&gt; F2 = A.get_factor(1)
&gt;&gt;&gt; A.size()
(1000, 2000)
</code></pre>
</body>
</html>
gen_doc/bin_pkgs/macosx/installer_readme.html.in 0 → 100644
+ 29
− 0
View file @ 65b16b8d
<!doctype html public "-//W3C//DTD HTML 4.0 Transitional //EN">
<html>
<head>
<meta name="GENERATOR" content="mkd2html 2.2.2">
<meta http-equiv="Content-Type"
content="text/html; charset=utf-8"> <title></title>
</head>
<body>
<h1>Introduction</h1>
<p> The FAµST library is designed to factorize matrices of interest into multiple sparse factors.</p>
<p>FAµST stands for Flexible Approximate Multi-Layer Sparse Transform.</p>
<p>Fore more information about the FAµST project, please visit the website: faust.inria.fr</p>
<h1>Use After Installing</h1>
<p>After installing, please take a look to the file /opt/local/faust-@CPACK_PACKAGE_VERSION@/doc/html/README.html. You&rsquo;ll find there a quick guide for an easy first use of FAµST and other instructions.</p>
<h1>Copyright and License Information</h1>
<p>FAµST integrates the MATIO library which the license is available within this package in /opt/local/faust-@CPACK_PACKAGE_VERSION@/doc.</p>
<p>The license will also be printed in the license tab just after the FAµST license.</p>
<p>MATLAB is a registered trademark of The MathWorks, Inc.</p>
</body>
</html>
gen_doc/bin_pkgs/macosx/licenses.html 0 → 100644
+ 763
− 0
View file @ 65b16b8d
This diff is collapsed.
license_matio.txt 0 → 100644
+ 25
− 0
View file @ 65b16b8d
MATIO Library
copyright (c) 2011-2018, Christopher C. Hulbert
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment