diff options
Diffstat (limited to 'doc/html/md__r_e_a_d_m_e.html')
| -rw-r--r-- | doc/html/md__r_e_a_d_m_e.html | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/doc/html/md__r_e_a_d_m_e.html b/doc/html/md__r_e_a_d_m_e.html new file mode 100644 index 0000000..a7db0ca --- /dev/null +++ b/doc/html/md__r_e_a_d_m_e.html @@ -0,0 +1,152 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>FOSSEE Scilab Octave Toolbox: FOSSEE Scilab Octave Toolbox</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(function() { init_search(); }); +/* @license-end */ +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectlogo"><img alt="Logo" src="Scilab_Logo.png"/></td> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">FOSSEE Scilab Octave Toolbox + </div> + <div id="projectbrief">This is a scilab toolbox to call octave functions. It requires octave to be installed on the system.</div> + </td> + <td> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.svg" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a> + </span> + </div> +</td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license-end */ +</script> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('md__r_e_a_d_m_e.html',''); initResizable(); }); +/* @license-end */ +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="PageDoc"><div class="header"> + <div class="headertitle"> +<div class="title">FOSSEE Scilab Octave Toolbox </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>This is a scilab toolbox to call octave functions. It requires octave to be installed on the system.</p> +<h1><a class="anchor" id="autotoc_md1"></a> +This toolbox has been built and tested using</h1> +<ol type="1"> +<li><code>OS - Linux Debian 10, Ubuntu 18.10 and 19.10 (64-bit)</code></li> +<li><code>Octave - Version 4.4.1, 5.1.0</code></li> +<li><code>Scilab - Version 6.0.x</code></li> +</ol> +<h1><a class="anchor" id="autotoc_md2"></a> +Software prerequisites:</h1> +<p>Run the following commands in the linux terminal</p><ol type="1"> +<li><code>sudo apt-get install build-essential (~117 MB download)</code></li> +<li><code>sudo apt-get install liboctave-dev (~103 MB download)</code></li> +<li><code>sudo apt-get install octave</code></li> +<li><code>sudo apt-get install scilab</code></li> +</ol> +<h1><a class="anchor" id="autotoc_md3"></a> +Install the required octave packages using the below command in linux terminal</h1> +<ol type="1"> +<li><code>sudo apt-get install octave-<pkg name></code> For example, to install signal package in octave, do</li> +</ol> +<ol type="1"> +<li><code>sudo apt-get install octave-signal</code></li> +</ol> +<h1><a class="anchor" id="autotoc_md4"></a> +Launch Scilab and run the following commands inside the scilab console</h1> +<ol type="1"> +<li><code>cd <path to fossee-scilab-octave-toolbox directory></code></li> +<li><code>exec builder.sce</code></li> +<li><code>exec loader.sce</code></li> +<li><code>help octave_fun</code> (then execute the examples appearing on the help page to test the toolbox)</li> +</ol> +<h1><a class="anchor" id="autotoc_md5"></a> +Building the source</h1> +<p>In case if executing the builder and loader files in scilab throw an error regarding .so files, you probably need to build the toolbox from source. Do the following on the linux terminal</p><ol type="1"> +<li>Download the fossee-scilab-octave-toolbox source from <a href="https://atoms.scilab.org"><code>atoms.scilab.org</code></a></li> +<li>Close scilab, if running</li> +<li><code>cd <path to fossee-scilab-octave-toolbox/src/ directory></code></li> +<li><code>make clean</code></li> +<li><code>make</code></li> +<li><code>make install</code> </li> +</ol> +</div></div><!-- contents --> +</div><!-- PageDoc --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li> + </ul> +</div> +</body> +</html> |