Advanced Topics

In this section we cover some more advanced topics around installation and configuration.

Config file

The config file is created the first time you run python -m remo_app init.

It gets stored in: HOME_DIRECTORY/.remo/remo.json

Location of your HOME directory depends upon your specific OS system.

Content:

{
  "conda_env": "path-to-conda-environment-where-you-installed-remo-app",
  "port": "8000",
  "server": "http://localhost",
  "user_email": "your-username@remo.ai",
  "user_name": "your-username",
  "user_password": "adminpass",
  "viewer": "electron"
}

NB: Changing some values would require running again python -m remo_app update in order for the changes to be processed.

Viewer

Accepted values:

  • electron
  • browser

By default, Remo uses Electron to run the app. This allows for more vertical space compared to using Remo in a browser.

If you prefer to use Remo in a browser, change the value of the field.


Uploading Data

When possible, Remo tries to link your local data in order to minimize needed extra storage. However, adding data still takes a bit of extra storage space. See below for more details.

Linking datasets

Images are linked and opened directly from your hard disk if you upload data using the Electron app and if they are not archive or annotation files.

This however means that if you move or delete your images after uploading them in Remo, Remo will fail to find them.

NB: even when linking data, Remo still creates a copy of smaller version of the images to show thumbnails and previews in an efficient way. Those shouldn't amount to more than 15% of the original size of the dataset.

Copying data

Annotations are automatically uploaded as new data on Remo. Image data will also be uploaded as a copy if it's passed as an archive, or if using the file picker directly from the Browser.


Database

We currently support only SQLlite.

Support for Postsgres and MySQL is in the plans at some point.

SQLlite Installation

SQLlite is pre-installed within a conda environment.

For manual installation, you can find some instructions here:

https://www.sqlitetutorial.net/download-install-sqlite/


Remo version

You can check your version of remo by either:

  • pointing the mouse to the Remo icon within the webapp
  • launching Remo from command line:

medium_width_pic


Docker Support WIP

Coming soon