Commit 5294dce67f6af06bc103e81ffe7917010ce06e10

Authored by Elena.Budnik
1 parent 0314bd32

help

help/ABC
1   -<h2><img src="js/resources/images/32x32/fav_amda.png"/> The ABCs of AMDA</h2>
  1 +<h2><img src="js/resources/images/32x32/fav_amda.png"/> The ABCs of AMDA : Obsolete !</h2>
2 2 <p><h2>A. How to Work with Parameters</h2>
3 3 ... just <b><i>drag</i></b> the Parameter from the WorkSpace Explorer Tree
4 4 and <b><i>drop</i></b> onto the opened module window.
... ...
help/downloadHOWTO
1   -1. To download a parameter/time table, <b><i>drag</i></b> it from the Parameters/Time Tables tree and <b><i>drop</i></b>
2   -onto the corresponding panel.</br>
3   -2. To download data for the intervals from the time table activate the <b><i>TimeTable mode</i></b> in the Time Selection area and <b><i>drag-and-drop</i></b>
4   - there the time table from the Time Tables tree.
  1 +<li>1. To download a parameter/time table, <i>drag</i> it from the Parameters/Time Tables tree and <i>drop</i>
  2 +onto the corresponding panel
  3 +<li>2. To download data for the intervals from the time table activate the <i>TimeTable mode</i> in the Time Selection area and
  4 +<i>drag-and-drop</i> there the time table from the Time Tables tree
5 5 </br>
6 6  
7 7  
... ...
help/myParameterHOWTO
  1 + <li>1. To construct a new parameter <i>drag</i> one of the AMDA parameters from the Parameters tree
  2 + and <i>drop</i> it onto the Construct Parameter text area.
1 3  
2   - To construct a new parameter <b><i>drag</i></b> one of the AMDA parameters from the Parameters Tree
3   - and <b><i>drop</i></b>it onto the Construct Parameter text area.<br/>
4   - <b><i>Attention!</i></b> Use only <b><i>LOW CASE</i></b> characters for parameter name<br/>
5   - Use <b><i>FLOAT</i></b> numbers in math expressions.<br/>
6 4 \ No newline at end of file
  5 +
7 6 \ No newline at end of file
... ...
help/plotHelp
... ... @@ -2,7 +2,7 @@
2 2 <h3>NEW DESIGN OF PLOT REQUEST</h3>
3 3 <hr>
4 4 As a lot of new plot options is added the plot request form has been completely redesigned. It is organised as multi-level tree<br/>
5   - To see/redefine the default plot options for selected element click an element of the tree hierachy on the left panel <br/>
  5 + To see/redefine the default plot options for an element click it in the tree hierachy on the left panel <br/>
6 6 Current selection is shown next to the corresponding element.<br/><br/>
7 7 Note that at any moment you can modify any option at any level.
8 8 <br/><br/>
... ... @@ -61,8 +61,8 @@
61 61 <li><b><i>Panel : Time Plot</i></b><br/>
62 62 allows use/combine different drawing types on the same panel :
63 63 Serie, Spectro, Tick Bar, Status Bar <br/>
64   - Note that <i>Tick Bar</i> or <i>Status Bar</i> alone cannot be plotted on the TimePlot panel
65   - <br/>
  64 + Note that <i>Tick Bar</i> and <i>Status Bar</i> cannot be plotted on the TimePlot panel
  65 + if alone -
66 66 you <b>should always plot also</b> another parameter of <i>Serie</i> or <i>Spectro</i> drawing type,
67 67 otherwise you will get an empty panel.
68 68 <br/><br/>
... ... @@ -119,9 +119,9 @@
119 119 <img class="left" src="help/images/image5.png"/>
120 120 <br/>
121 121  
122   - <font color="red"><b>CU: As for the moment catalog uploading is not implemented (as well as 'dateTime' parameter type
  122 + <font color="red">CU: As for the moment catalog uploading is not implemented (as well as 'dateTime' parameter type
123 123 in Catalog Editor) we supply CU with special 'Epoch Plot test' catalog (above) with the name <i>epoch_test</i>.
124   - You will find this catalog in the Catalogs/My Catalogs section of your WorkSpace Explorer</b></font>
  124 + You will find this catalog in the Catalogs/My Catalogs section of your WorkSpace Explorer</font>
125 125 <hr>
126 126 <li><b><i>Panel : Instant Plot</i></b><br/>
127 127 'instant spectrum' - 1D[2D] cut for 2D[3D] objects;<br/>
... ... @@ -129,14 +129,14 @@
129 129 Note: instant cut may be get also directly by right mouse click on spectrogram plot
130 130 <hr>
131 131 <li><b><i>Panel : Status Plot</i></b><br/> permits only one drawing type - Status Bar.<br/>
132   - <font color="red"><b>CU : For the moment <i>Status Bar</i> drawng type is implemented for the
133   - STEREO SWEA quality parameters only.</b></font>
  132 + <font color="red">CU : For the moment <i>Status Bar</i> drawng type is implemented for the
  133 + STEREO SWEA quality parameters only.</font>
134 134  
135 135 <hr>
136 136 <li><b><i>Panel : Tick Plot</i></b> permits only one drawing type - Tick Bar.<br/>
137 137 Outputs parameter as tick values for major time ticks. <br/>
138   - <font color="red"><b>CU : Known bug: for some time intervals <i>NaN</i> is output.
139   - Will be fixed.</b></font>
  138 + <font color="red">CU : Known bug: for some time intervals <i>NaN</i> is output.
  139 + Will be fixed.</font>
140 140 </ol>
141 141 <br/>
142 142 <b>Note :</b> you can plot/save <i>Plot Template</i> : plot with empty panels
... ... @@ -162,38 +162,40 @@
162 162 Selection of <i>Left / Right</i> Y-axe (associated with parameter!!)<br/>
163 163 is made at the <i>parameter</i> level.
164 164 </ol>
165   -<hr>
  165 + <hr>
166 166 <li><h3>Parameter : self-explanatory</h3>
167 167  
168 168 <ol>
169   - <li><b>Note :</b>Some fields in the form of parameter level are 'editable'.<br/>
170   - Introdicing of math expressions in those fields has no sense.<br/>
  169 + <li><b>Note :</b>Some fields in the form of parameter level are 'editable'.
  170 + Introdicing of math expressions in those fields has no sense.
171 171 May be later on...
172   -
  172 + <hr>
173 173 <li><i>Arguments :</i><br>
174   - Two possibilities to select vector components<br/>
175   - - directly from parameter tree or by <b>Arguments</b> block.<br/>
176   - <b>Direct selection from the tree doesn't work for the moment<br/>
177   - <font color="red">CU : Which way to select vector components do you prefer ?</font></b>
  174 + Two possibilities to select vector components
  175 + - directly from parameter tree or by <i>Arguments</i> block.<br/>
  176 + <b>Direct component selection from the tree doesn't work for the moment</b>
178 177 <br/><br/>
179 178 <img class="left" src="help/images/plot8.png"/>
180 179 <br/>
181   -
182   - <li> You may colorer plotted parameter with the value of another parameter<br/>
  180 + <hr>
  181 + <li> You may colorize plotted parameter with the value of another parameter
183 182 by using <i>Colored Parameter</i> option (drag/drop parameter)
184 183 <br/><br/>
185 184 <img class="left" src="help/images/image2.png"/>
186 185 <br/>
187   -
188   - <li><i>Interval ticks</i> can be useful when one produces plot for time table input<br/>
  186 + <hr>
  187 + <li><font color="red">CU : Sometimes you may get empty panel without any error.
  188 + Check out please if </font><i>Symbols</i> <font color="red">selection will plot the parameter. Note such cases.</font>
  189 + <hr>
  190 + <li><i>Interval ticks</i> can be useful when one produces plot for time table input
189 191 in Epoch Superposed page mode.
190   -
191   - <li><i>Error Bar</i>. To plot error bars you should define one (in case of <i>Delta</i>)<br/>
  192 + <hr>
  193 + <li><i>Error Bar</i>. To plot error bars you should define one (in case of <i>Delta</i>)
192 194 or two (in case of <i>Min/Max</i>) parameters used as 'error values'.<br/> You may create those
193 195 parameters yourself using for example <i>sqrt</i> of the existing parameter.
194   -
195   - <li><i>Predefined Drawing Types</i> are defined for some parameters<br/>
196   - f.i. - vex_xyz, mex_xyz - Orbit Serie; e_mgs_er - Spectro<br/>.
  196 + <hr>
  197 + <li><i>Drawing Types</i> are predefined for some parameters -
  198 + f.i. - vex_xyz, mex_xyz - Orbit Serie; e_mgs_er - Spectro.<br/>
197 199 When you drag/drop such a parameter its drawing type is set automatically.
198 200 Will be extended for all parameters when there is sense.
199 201 </ol>
... ...
help/releaseNotes.2.0.0
... ... @@ -2,18 +2,68 @@
2 2 <i>release version : alpha 2.0.0<br/>release date : 2016-05-16</i>
3 3  
4 4 <ul>
5   - <li><img src="js/resources/images/64x64/plot.png" width=24/><i>Plot -a lot of new features,
6   - new interface design.
7   - Use Plot Module help ("?") to learn more
8   - <li><img src="js/resources/images/64x64/catalog.png" width=24/> catalog
9   - <li><img src="js/resources/images/64x64/visu_catalog.png" width=24/> catalog
10   - <li><img src="js/resources/images/64x64/statistics.png" width=24/> Catalogs
11   - <li><img src="js/resources/images/64x64/search.png" width=24/> data Mining
12   - <li><img src="js/resources/images/64x64/edit.png" width=24/> my parameter
13   - <li><img src="js/resources/images/64x64/interop.png" width=24/> inter
14   - <li><img src="js/resources/images/64x64/download_manager.png" width=24/> down
15   - <li><img src="js/resources/images/64x64/mydata.png" width=24/> upload
16   - <li><img src="js/resources/images/64x64/timeTable.png" width=24/> time table
17   - <li><img src="js/resources/images/64x64/operations.png" width=24/> time table oper
18   - <li><img src="js/resources/images/64x64/help.png" width=24/>Help : Obsolete, TBD</i>
  5 + <li><img src="js/resources/images/16x16/view_tree.png" width=24/> WorkSpace Explorer
  6 + <li>From now Amda DataBase parameter
  7 + tree is constructed automatically from Amda Spase Registry. Info <img src="js/resources/images/16x16/info_mini.png"/>
  8 + is generated for all
  9 + Mission/Instrument/DataSet nodes. <font color='red'>Q. Is it useful to have info for ALL those nodes ?</font>
  10 + <li> We had not enough time to fill all info fields.
  11 + <font color='red'>Q. If you can add/modify some info ? Is naming convention OK?</font>
  12 + <li><i>Target</i> filtering doesn't work. Fails to load Targets while creating filter.
  13 + <li> No access to Remote DataBases Observations/Simulations in the current version.
  14 + <li> Current Amda instance uses Test DataBase with limited data coverage.
  15 + <li><i>"_gsm"</i> parameters (except <i>imf_real_gsm</i>) are not for tests
  16 + <hr>
  17 + <li><img src="js/resources/images/64x64/plot.png" width=24/> Plot <br/> Plot module has a lot of new features,
  18 + and completely new interface. Use Plot help ( "?" in the right upper corner of Plot Interface ) to learn more
  19 +<hr>
  20 + <li><img src="js/resources/images/64x64/statistics.png" width=24/> Statistics
  21 + <li>New module ( existed in the first Amda ). Produces output in a form of catalog : Start - Stop - Param Statistics Value.
  22 + Note that statistics can be calculated for <i>any</i> parameter type ( scalar, vector, array).
  23 + <li>List of stat functions will be extended. <font color='red'>Q. Which functions to be added ?</font>
  24 +<hr>
  25 + <li><img src="js/resources/images/64x64/catalog.png" width=24/> Catalog Editor
  26 + <li>New module ( existed in the first Amda ). Extended version of TimeTable editor.
  27 + <li> <i>dateTime (ISO)</i> parameter type isn't implemented (cannot be shown in editor) in this version.
  28 + We supply you with a special catalog <i>epoch_test</i> (see resources/Catalogs/My Catalogs) with parameter
  29 + of the <i>dateTime</i> type to test Epoch Plot.
  30 + <li>Catalogs Upload/Download isn't implemented in this version.
  31 + <li>You may open Catalog Editor from context menu of Amda Tree (<i>Edit Catalog</i>) or doubleclick a catalog in the tree
  32 + <li>To create new catalog click CatalogEditor icon on the desktop to open an empty form
  33 +<hr>
  34 + <li><img src="js/resources/images/64x64/visu_catalog.png" width=24/> Catalog Visualization
  35 + <li>New module. Open it from context menu or CatalogEditor module.
  36 + <li>Direct click of icon on desktop opens empty form.
  37 + Drag/drop of catalog name onto the form isn't implemented yet.
  38 +<hr>
  39 + <li><img src="js/resources/images/64x64/search.png" width=24/> Data Mining <br/>
  40 + <li>Interface isn't changed but all the calculations are made by new kernel
  41 + <li>Not all the functions are implemeneted - use <i>Simple Math Functions</i> for tests
  42 + <li><font color="red">Sometimes there is no parameter arguments description file - and system throws an exception.
  43 + Please note such cases</font>
  44 +<hr>
  45 + <li><img src="js/resources/images/64x64/edit.png" width=24/> Derived Parameter <br/>
  46 + <li>Interface isn't changed but all the calculations are made by new kernel
  47 + <li>Not all the functions are implemeneted - use <i>Simple Math Functions</i> for tests
  48 + <li>Any parameter type (scalar, vector, array) can be used for parameter construction
  49 +<hr>
  50 + <li><img src="js/resources/images/64x64/download_manager.png" width=24/> Download (Data)<br/>
  51 + <li> Temporary limited time formats
  52 + <li> New file formats
  53 + <li> New option <i>Use first param as reference for sampling</i>
  54 + <li> New option <img src="js/resources/images/16x16/edit.png"/> selecting component of the array
  55 +<hr>
  56 + <li><img src="js/resources/images/64x64/mydata.png" width=24/> Upload Data / MyData Parameters <br/>
  57 + Interface isn't changed but all the calculations are made by new kernel
  58 +<hr>
  59 + <li><img src="js/resources/images/64x64/timeTable.png" width=24/> Time Table<br/>
  60 + 'Big time table' problem is fixed <font color='red'>Q. If possible test please big ( &gt; 5000-10000 lines) time tables</font>
  61 +<hr>
  62 + <li><img src="js/resources/images/64x64/operations.png" width=24/> Time Table Operations <br/>
  63 + No modifs in this version. Will be executed by new kernel.
  64 +<hr>
  65 + <li><img src="js/resources/images/64x64/interop.png" width=24/> Interoperability <br/>
  66 + No modifs
  67 +<hr>
  68 + <li><img src="js/resources/images/64x64/help.png" width=24/> Help<br/> Obsolete, TBD
19 69 </ul>
... ...