|
| 1 | +A Web Browser Interface and Server for Matlab and Octave |
| 2 | +======================================================== |
| 3 | + |
| 4 | + |
| 5 | +About |
| 6 | +----- |
| 7 | + |
| 8 | +A simple experimental web browser interface for Matlab and Octave. |
| 9 | +Running the <code>web_server('start')</code> command starts a local |
| 10 | +_TCP_ and _web_ server and opens a connected web browser window which |
| 11 | +accepts Matlab and Octave commands as input. Plots are translated via |
| 12 | +the Plotly Javascript library into Html graphs. |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +Installation |
| 18 | +------------ |
| 19 | + |
| 20 | +Download the _webserver_ archive and extract the contents in a |
| 21 | +convenient folder. |
| 22 | + |
| 23 | + |
| 24 | +Requirements |
| 25 | +------------ |
| 26 | + |
| 27 | +1. A modern [web browser](https://www.mozilla.org/en-US/firefox) |
| 28 | +with Javascript enabled and flexbox CSS support. |
| 29 | + |
| 30 | +2. [Matlab](https://www.mathworks.com/matlab) or |
| 31 | +[Octave](https://www.gnu.org/software/octave) installed. |
| 32 | + |
| 33 | +3. [Java](http://www.oracle.com/technetwork/java/javase/downloads) |
| 34 | + installed and support enabled with Matlab and Octave. |
| 35 | + |
| 36 | + |
| 37 | +Usage |
| 38 | +----- |
| 39 | + |
| 40 | +Simply change to the extracted folder or add it to the Matlab/Octave |
| 41 | +paths and run the command |
| 42 | + |
| 43 | + web_server( 'start' ) |
| 44 | + |
| 45 | +to start the web server and open the mirrored Matlab/Octave session in |
| 46 | +the default web browser. To stop the sever run the command |
| 47 | + |
| 48 | + web_server( 'stop' ) |
| 49 | + |
| 50 | +To see the available options enter |
| 51 | + |
| 52 | + help web_server |
| 53 | + help tcp_server |
| 54 | + |
| 55 | + |
| 56 | +Known Issues |
| 57 | +------------ |
| 58 | + |
| 59 | +1. The Plotly library needs further improvements to fully support |
| 60 | + Octave (currently only line plots are supported). The main issue is |
| 61 | + that a lot of struct calls in the Plotly conversion function are |
| 62 | + accessed as _s.Color_ or _s.XLabel_ where in Octave the fields are |
| 63 | + all in lower case, that is _s.color_ and _s.xlabel_. |
| 64 | + |
| 65 | + |
| 66 | +Credits |
| 67 | +------- |
| 68 | + |
| 69 | +[1] [Matlab Webserver by Dirk-Jan Kroon](https://www.mathworks.com/matlabcentral/fileexchange/29027-web-server) |
| 70 | + |
| 71 | +[2] [Plotly Javascript library](https://plot.ly/javascript) |
| 72 | + |
| 73 | + |
| 74 | +Software License |
| 75 | +---------------- |
| 76 | + |
| 77 | +[GNU Affero General Public License AGPL](https://www.gnu.org/licenses/agpl-3.0.txt) |
0 commit comments