Quick Start ¶

This document will show you how to get up and running with Inlinino. You will have inlinino installed in 10 minutes and start logging data in 15 !

If you are already using python 3.x, go ahead to those setup instructions.

Table of Contents

Quick Start

Easy installation ¶

The quick and easy installation is available on Windows only for now. If you are on OSX or Linux please go ahead to the advance installation section.

Download ¶

Download the setup file for your operating system:

Windows 32-bits

Windows 64-bits

If you are logging data from analog instruments and therefor use an Arduino make sure the appropriate driver are installed. Instructions are available on Arduino’s website.

Install ¶

Double click on the setup file you just downloaded and follow the instructions.

Quick configuration ¶

Let’s just set up the instrument(s) you want to log data from.

Create an empty text file in C:\Program Files\Inlinino\cfg\ named “user_cfg.json”.

Copy the following empty instrument configuration in the file:
{
  "instruments":{

  }
}
Pick one or mutiple instruments bellow and add there configuration to the configuration file you just created.

WET Labs ECO-Triplet

WET Labs ECO-BB9

SBE TSG

Simulator (for testing)

Your configuration file will look like this if you choose to log data from a TSG and a BBFL2.
{
  "instruments":{
    "TSG":{
      "module":"SBE",
      "name":"TSG",
      "variables":["T", "C", "S"],
      "units":["deg_C", "S/m", "no units"]
    },
    "BBFL2_200":{
      "module":"WETLabs",
      "name":"Triplet",
      "lambda":[660, 695, 460],
      "varname_header":["beta", "chl", "cdom"],
      "units":"counts"
    }
  }
}
Edit path to the user configuration file you just created by editing line 16 of "C:\Program Files\Inlinino\__main__.py.
# Original line
Inlinino(os.path.join(sys.path[0], 'cfg', 'simulino_cfg.json'))
# User specific configuration
Inlinino(os.path.join(sys.path[0], 'cfg', 'user_cfg.json'))

Note

The user configuration file can have any name and can be located anywhere. By convention all Inlinino’s configuration files are finishing by _cfg.json and are located in "C:\Program Files\Inlinino\cfg\".

Log your first data ¶

1. Start Inlinino by double clicking on one of the Icon shortcut (on the Desktop or in the Start menu > Programs > Inlinino). If everything went well you will see a window similar to this:

It can take up to 30 seconds for the interface to show up on slow computers.

Note

If nothing is showing up try to troubleshoot with indications available in Common errors section

Connect instruments:

Click on > button on the left of each instrument.

The status of the instrument will switch to “active”.

Data will be plotted on the figure on right and displayed on the top left.

Note

More details about the instruments configuration and interface can be found in the Configuration and GUI sections.

Start logging data

Click on Start button at the bottom left to start recording the data.

By default data is recorded at 1 Hz and new log file are made hourly.

Note

More details about the logger configuration and interface can be found in the Configuration and GUI sections.

Next step ¶

The GUI is intuitive and very simple fill free to explore all the possibility by yourself, you cannot break anything. If you’re not sure about a command, check the documentation.

Want to do more ? Look at the configuration files, few parameters can be adapted to your need there.

The instrument you would like to log data from is not available ? Add it ! There is an example on how to add the code required in the Adding a custom instrument section.

Note

Any difficulties ? Ideas of improvements ? Let me know, I will be happy to discuss them with you. Nils

Quick Start¶

Easy installation¶

Download¶

Install¶

Quick configuration¶

Log your first data¶

Next step¶