LPP » INSTRU » QLop » SciQLOP

h1. SciQlop Status

"Priorities : Google doc link":https://docs.google.com/spreadsheets/d/1fIQDHRDhKJtTxnRRDlmInM25QFDaEuZ8gctZ523m6wU/edit#gid=0

h2. Scientific Objectives and Performances

|.Functionnality |.Status(% done)|
|SciQLOP should be portable, and an executable/setup should be available for Linux, Mac, Windows||
|Installing SciQLOP must be easy, must not require to read a documentation or install dependencies||
|When opened SciQLOP should by default reload the previous state (data products, plots, plugins, etc.)||
|SciQLOP comes with good user documentation, including galleries, examples and tutorials including video tutorials.||
|SciQLOP should propose the same functionalities on all platforms.||
|SciQLOP should propose the same performances on all platforms.||
|SciQLOP's GUI should remain light, beautiful and intuitive||
|Exploring databases, browsing data should be easier/faster than with other existing softwares||
|SciQLOP should provide efficient and transparent data browsing, access to user python routines, collaborative cataloging features with and without machine learning||
|SciQLOP should remain responsive when plotting 10 millions of points on a standard machine.||
|SciQLOP should have a limited list of data type it can handle and group them by common traits (scalars, vectors, image...).||
|SciQLOP may be able to provide features depending on the data type, source, unit or any condition/property the user may define or program.||
|Each modification of the data between the source (server) and the plot should be documented||
|SciQLOP should be used by students as a formation tool : provide users with knowledge toolkits associated to used quantities||
|SciQLOP should provide users with easy access to documentations on data, missions, instruments, etc.||
|SciQLOP should allow users to access wikipedia plasma/mission-related articles and suggest users to edit/add content.||
|SciQLOP should allow users to save and restore sessions.||
|SciQLOP user session should contain all data to restore its previous state.||

h2. Code redistribution

|.Functionnality |.Status(% done)|
|SciQLOP source code will be GPLv2.|{background:green;color:white}. 100|
|SciQLOP source folder should contain the files:README, INSTALL, COPYING, CHANGELOG.||
|All SciQLOP source files should contain GPLv2 header.|{background:green;color:white}. 100|
|All SciQLOP dependencies should be compatible with GPLv2.||

h2. Code versioning

|.Functionnality |.Status(% done)|
|SciQLOP source code modifications should have a link between features or bug corrections and code revisions||
|SciQLOP source code should be hosted on the laboratory server hephaistos1 with the mercurial version system.||

h2.Code Writing

|.Functionnality |.Status(% done)|
|SciQLOP developer's documentation, roadmap, issues, etc. will be done on the Redmine application : https://hephaistos.lpp.polytechnique.fr/redmine/projects/sciqlop||
|Unit test are developed for all modules and performed after each important merge||
|SciQLOP's code is homogeneous in its syntax and philosophy to guarantee easy maintainability.||
|SciQLOP's code is self-explanatory, comments are used to explain goals, methods rather than instructions. Comments record development flow (hacks, todos, etc.)||
|SciQLOP's code is based on the Qt framework and plotting capabilities use the QcustomPlot1 API.||

h2. SciQLop Modules

|.Functionnality |.Status(% done)|
|{background:grey;color:white}. Core |{background:grey}. |
|{background:#ddd;color:grey}.Database |{background:#ddd}. |
|||
|||
|||
|||
|||
|||
|||
|||
|||
|||
|||
|||
|||
|||
|||
|||
|||
|||
|||
|{background:#ddd;color:grey}.Data Downloader |{background:#ddd}. |
|{background:grey;color:white}.Plot |{background:grey}. |
|{background:#ddd;color:grey}.General |{background:#ddd}. |
|SciQLOP should be able to plot all kinds of data relevant to space plasma missions(scalar, vector, tensor, spectrogram||
|Each plot element (context : colorbars, ticks, titles, labels etc. ; data : lines, style, dots, etc.) should be clickable and customizable||
|Controls on figure items should be identical in all kinds of plots (e.g. changing title, labels etc. is done identically for all kinds of plots).||
|A plot “style” (context and data style) can be copy/pasted onto another plot ||
|Users may define custom plot styles and save/reload them as desired||
|Plots should provide visualization of available metadata (instrument modes, etc.)||
|Each plot/view should provide the context menu associated to the data type.||
|Each plot/view should allow the user to select a portion of data and perform specific operations on it, such as labelling it, building new plots or applying data analysis methods on it (e.g. get statistical quantities such as mean/std, etc.).||
|Data can be selected by dragging a zone onto the plot: Time interval as rectangle for time series for example. A box in 3d plot/view for example.||
|For time dependent data the plot/view may ask for more data when the user scrolls to the borders of the plot/view. ||
|Users should experience no significant lag related to downloading data associated with scrolling windows||
|Each plot/view should allow the integration of custom controls (user defined gui widgets) provided by the current plotted data. The control may be provided as a QWidget.||
|Each plot/view should be easily duplicable.||
|Figures/plots can be linked together or not.|{background:green;color:white}. 100|
|Linked plots will zoom/unzoom, scroll together (horizontally)|{background:green;color:white}. 100|
|A Lens effect enables the user to zoom on a part of the data without changing the plot range (like a lens effect on Gimp-like software). This can be made by adding a plot window overlapped onto the plot.||
|Any plot should come with a default legend, customizable by the user||
|Any plot can be dragged to a folder and exported as an image (eps, png, jpg)||
|User can select multiple plots holding shift key and drag them onto a folder to export images. SciQLOP ask the user whether multiple images or a summary plot should be done.||
|Mouse wheel can be used to scroll in time when the figure is selected.||
|Plot adjustments controls appear on specific locations on mouse hover. This keeps the interface clear but still customizable.||
|{background:#ddd;color:grey}.Scalar Time series |{background:#ddd}. |
|Contextual menu should give users rapid access to statistical functionalities such as mean(), std().||
|Data holes are handled in line style mode as a line segment.||
|Line width can be adjusting by clicking+mouse wheel||
|{background:#ddd;color:grey}.Vector Time series |{background:#ddd}. |
|SciQLOP can plot one or more components of a vector as a function of time||
|SciQLOP is aware the quantity is part of a vector. If Bx is plotted it knows which products represent By and Bz and can easily add them on the plot.||
|The contextual menu on a vector plot should allow users to easily transform their vector into another basis, user-provided and generic basis such as GSE, GSM, etc. or MVA.||
|Vectors displayed on linked plots will be represented in the same basis dynamically (one change of basis on one of the linked plot will change all of them)||
|Vectors can be plotted in 3D or 2D-projection as 3D vectors as a function of time. This representation will be useful for visualizing aspects specific to vectors such as change of direction (e.g. waves & discontinuities) not easily viewable in the time series format.||
|{background:#ddd;color:grey}.Spectrograms |{background:#ddd}. |
|SciQLOP should enable the same plot/context functionalities for all spectrograms, no matter the nature of the data (particles or waves), this include color range, colormaps, etc.||
|Characteristic frequencies should be overplottable as time series.||
|Using WAMP for theoretical wave frequencies and damping should be possible||
|Plasma eigenmodes visualization toolkit can be called from the spectrograms contextual menu||
|Data holes are handled by showing the background color/texture||
|Colormap by clicking on the colorbar, color range can easily be adjusted from cursors appearing on the colorbar on mouse hover||
|{background:#ddd;color:grey}.Orbits |{background:#ddd}. |
|SciQLOP provides the user with three 2D projections of the magnetosphere/heliosphere and its key regions||
|Heliosphere/Magnetospheric plot use different models (Tsyganenko, shue, Parker Spiral, etc.) easily interchangeable by the user.||
|Orbits of the satellites from which data is currently being viewed appears overplotted on the three 2D magnetospheric/heliosphere projections||
|The position of the spacecraft for the considered intervals must be clearly visible on the trajectory with a colored portion of the orbit, the color being associated to a particular plot (or set of linked plots).||
|Changing the interval range of a spacecraft on its orbit must change the plot time range accordingly and dynamically.||
|SciQLOP should offer an interoperability with CDPP/3DView to view orbits in 3D||
|{background:grey;color:white}.SpaceData |{background:grey}. |
|{background:grey;color:white}.App |{background:grey}. |