Skip to content
Tool for 1st Quality Control on Hydrographic Cruise Data.
Branch: master
Clone or download

README.md

AtlantOS Ocean Data QC DOI

This software is an interactive tool for making the first Quality Control (1st QC, QC1) on Hydrographic Cruise Data. It is basically built in Python, Node, JavaScript, HTML5 and related technologies, and can run on multiple platforms.

demo

Installation

It's not essential for this software to run, but in order to take advantage of the main functionalities of this software program it is absolutly recommended to have GNU Octave installed, as most parameter calculations relies on Octave/Matlab code. Installers can be found here

Using built-in installers

Source code:

Manual Installation

  1. Download and install base dependencies:

    1. Download and install Python 3.x. Recommended downloader and instructions: https://conda.io/miniconda.html

    2. Download and install yarn. Follow instructions from: https://yarnpkg.com/ (Alternatively you can use npm)

    3. Optional but very recommended for functionality: GNU Octave

  2. Download this project

  3. Install the python ocean_data_qc package and its dependencies in your python setup (if you have installed python through miniconda/anaconda and is not in PATH, you have to use Anaconda Prompt as command shell):

     python setup.py develop
         or for non-root install in Linux:
     python setup.py develop --user
    
  4. Install the node dependencies in the ocean_data_qc_js folder

     cd ocean_data_qc_js
     yarn install             # or yarn install
    
  5. Open the GUI from the ocean_data_qc_js folder

     cd ocean_data_qc_js
     npm start               # or yarn start
     (first time launching delays some time, please wait)
    

Technologies Used

  • Electron (formerly known as Atom Shell). Electron is an open source library developed by GitHub for building cross-platform desktop applications with HTML, CSS, and JavaScript. Electron accomplishes this by combining Chromium and Node.js into a single runtime and apps can be packaged for Mac, Windows, and Linux. The application uses Electron to embed in an application the bokeh plots and drive the user interaction with interface, providing also all the menus and interfaces.

  • Bokeh (Python Library). Bokeh is an interactive visualization library that targets modern web browsers for presentation. Its goal is to provide elegant, concise construction of versatile graphics, and to extend this capability with high-performance interactivity over very large or streaming datasets. Bokeh is the main library for the application, as deals with graphic presentation and interaction (Bokeh Development Team (2014). Python library for interactive visualization. http://www.bokeh.pydata.org)

  • Octave. GNU Octave is a high-level interpreted language, primarily intended for numerical computations. It provides capabilities for the numerical solution of linear and nonlinear problems, and for performing other numerical experiments. It also provides extensive graphics capabilities for data visualization and manipulation. The GNU Octave language is quite similar to Matlab™ so that most programs are easily portable. The application uses GNU Octave to drive main oceanographic calculations, as it's actually the main used language in that field of work, and most typical Matlab™ open source oceanographic libraries were built in Matlab™. Running these calculations directly in GNU Octave allows to easy integrating code from researchers.

  • Python. Python version 3 is the main language in the application. Most processing on data and files are performed through Pandas and/or NumPy libraries in python, and sent to Bokeh, which is also built on python and has an own javascript library for displaying and interacting. Python source code is presented in ocean_data_qc folder in the application.

  • JavaScript. Electron is built on node, that is built with JavaScript. All code for menus, screens, and interacting elements on the application are made with Javascript. Some of the functionality are provided directly by Electron and some other by Bokeh, but the code to merge all these things were built with JavaScript. JavaScript source code is presented in ocean_data_qc_js folder in the application.

License

This project is licensed under the GPLv3 License - see the LICENSE file for details

Authors

References

You can’t perform that action at this time.