roboticsmicrofarms/plantdb repository overview

The open source code for this project is on github⁠.

⁠Docker image for local ROMI database

More detailed instructions on the official ROMI documentation here⁠.

⁠Requirements

To run it, you need to have a valid local ROMI database.

⁠Set up a local database

1. You need to create a directory where to put the data, e.g. /data/ROMI_DB and add a file called romidb:

   mkdir -p /data/ROMI_DB
   touch /data/ROMI_DB/romidb
   

   Copy

2. Then define its location in an environment variable ROMI_DB:

   export ROMI_DB=/data/ROMI_DB
   

   Copy

Notes:

⁠Example datasets

To populate your database with example datasets, you may use the shared_fsdb CLI as follows:

shared_fsdb $ROMI_DB --dataset all

⁠Starting the plantdb docker image

Assuming you either have a $ROMI_DB environment variable pointing at a local ROMI database or used the shared_fsdb to set up one, you can then start a container based on the the roboticsmicrofarms/plantdb docker image with:

docker run -p 5000:5000 -v $ROMI_DB:/myapp/db -it roboticsmicrofarms/plantdb

Note that -v ROMI_DB:/myapp/db performs a bind mount of the host directory $ROMI_DB inside the container under /myapp/db. This allows to access the local database from within the running container. See the official Docker documentation⁠.

⁠Usage

Once it's up, you should be able to access the REST API here: http://localhost:5000/⁠

To access the REST API, open your favourite browser and use URLs to access:

• the list of all scans: http://0.0.0.0:5000/scans⁠
• the 'real_plant' dataset: http://0.0.0.0:5000/scans/real_plant⁠

You should see JSON formatted text.

This software was developed during the Romi⁠ Project, which received funding from the European Union’s Horizon 2020 research and innovation program under grant agreement No 773875⁠.