ATOMS: atomsSetConfig online help
[scilab.git] / scilab / modules / atoms / help / en_US / _atomsGettingStarted.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="_atomsGettingStarted">
14
15   <refnamediv>
16     <refname>Getting started</refname>
17   </refnamediv>
18         
19   <refsection>
20     <title>Introduction</title>
21     <para>
22                 This page teaches how to get started with ATOMS module manager on the
23                         scilab platform towards a session example. It describes how one can install
24                         a module and load it in Scilab environment.
25                 </para>
26         </refsection>
27         
28   <refsection>
29     <title>Atoms</title>
30     <para>
31                         <itemizedlist>
32                                 
33                                 <listitem>
34                                         <para>
35                                                 <emphasis role="strong">Configure ATOMS to display extra-informations</emphasis> 
36                                                 <programlisting>
37 <![CDATA[-->atomsSetConfig('Verbose','True');]]>
38                                                 </programlisting>
39                                         </para>
40                                 </listitem>
41                                 
42                                 <listitem>
43                                         <para>
44                                                 <emphasis role="strong">List available modules</emphasis> 
45                                                 <programlisting>
46 <![CDATA[
47 -->atomsList();
48
49       ampl_toolbox - An interface to load .nl files created by AMPL
50        ANN_Toolbox - ANN Toolbox
51             conmin - A Scilab interface to the conmin optimization method
52              CUTEr - Testing environment for optimization and linear algebra solvers
53        dace_scilab - This is a conversion of the well known DACE kriging toolbox for Matlab.
54        dde_toolbox - Dynamic Data Exchange client for Scilab
55         HYDROGRv50 - Models and function for operational hydrology
56            lolimot - A fast neural network - LOcal LInear MOdel Tree
57       module_lycee - Scilab pour les lycĂ©es
58               NISP - Non Intrusive Spectral Projection
59            plotlib - "Matlab-like" Plotting library for Scilab
60           scilab2c - Translate Scilab code into C code
61             scipad - Scipad 7.20
62            simplex - This package contains the simplex optimization method
63    sndfile_toolbox - Read & write sound files
64            stixbox - Statistics toolbox for Scilab 5.2
65 ]]>
66                                                 </programlisting>
67                                         </para>
68                                 </listitem>
69                                 
70                                 <listitem>
71                                         <para>
72                                                 <emphasis role="strong">Install a module</emphasis>
73                                                 Installing a module download and extract it.
74                                                 <programlisting>
75 <![CDATA[
76 -->atomsInstall('NISP');
77
78     NISP (2.1) will be installed in the 'allusers' section
79     Installing NISP (2.1) ... success
80
81 ]]>
82                                                 </programlisting>
83                                         </para>
84                                 </listitem>
85                                         
86                                 <listitem>
87                                         <para>
88                                                 <emphasis role="strong">Load a module</emphasis>
89                                                 The module is installed but it's not loaded in the scilab environment
90                                                 and its functionnalities are not available yet.
91                                         </para>
92                                         <para>
93                                                 <inlinemediaobject>
94                                                         <imageobject>
95                                                                 <imagedata fileref="../images/dialog-information.png"/>
96                                                         </imageobject>
97                                                 </inlinemediaobject>
98                                                 By default, a module is added to the list of modules to load at Scilab
99                                                 start when it's installed.
100                                                 <emphasis>
101                                                 (&gt;&gt; More information on the autoload
102                                                 system :
103                                                         <simplelist type="inline">
104                                                                 <member>
105                                                                         <link linkend="atomsAutoloadList">atomsAutoloadList</link>
106                                                                 </member>
107                                                                 <member>
108                                                                         <link linkend="atomsAutoloadAdd">atomsAutoloadAdd</link>
109                                                                 </member>
110                                                                 <member>
111                                                                         <link linkend="atomsAutoloadDel">atomsAutoloadDel</link>
112                                                                 </member>
113                                                         </simplelist>
114                                                 ).
115                                                 </emphasis>
116                                         </para>
117                                                 
118                                         <para>
119                                                 
120                                                 <programlisting>
121
122                         <![CDATA[
123 -->atomsLoad('NISP');
124       
125     Start NISP Toolbox
126       Load gateways
127       Load help
128       Load demos
129 ]]>
130                                         </programlisting>
131                                         </para>
132                         </listitem>
133                                 <listitem>
134                                         <para>
135                                                 <emphasis role="strong">Remove a module:</emphasis> 
136                                                 <programlisting>
137 <![CDATA[
138 -->atomsRemove NISP
139   
140     NISP (2.1) will be removed from the 'allusers' section
141     the package NISP (2.1) is currently loaded, It will removed at next Scilab restart
142 ]]>
143                                                 </programlisting>
144                                         </para>
145                                 </listitem>
146                         </itemizedlist>
147                 </para>
148   </refsection> 
149         
150   <!-- ===================================================================== -->
151   <!-- Authors -->
152   <!-- ===================================================================== -->
153   <refsection>
154     <title>Authors</title>
155     <simplelist type="vert">
156       <member>Pierre MARECHAL - DIGITEO</member>
157     </simplelist>
158   </refsection>
159 </refentry>