Skip to content

Commit

Permalink
continuing main Tuto page
Browse files Browse the repository at this point in the history
  • Loading branch information
fabfabBesnard committed Mar 18, 2021
1 parent 4a879d5 commit 7cd35f9
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
1 change: 0 additions & 1 deletion docs/Scanner/install/romidb_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ python3.7 -m pip install flask flask-restful flask-cors && \
python3.7 -m pip install .
```


## Initialize a ROMI database

The `FSDB` class from the `romidata` module is used to manage a local file system for data storage.
Expand Down
16 changes: 11 additions & 5 deletions docs/Scanner/tutorials/plant_3d_explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,31 @@ After this tutorial, you should be able to:
* Create and activate isolated python environment (see [here](/docs/Scanner/install/create_env.md) )

## Linked documentation
* [Manual of the romi Plant 3d explorer](tobedone)
* [Manual of the romi Plant 3d explorer](/docs/plant_3d_explorer/index.md)

## Step-by-step tutorial
Principle: the `plant 3d explorer` is a web client that will display in your favorite web browser data exposed by a server (here, romi `plantdb`) on a particular url. The process consists in pointing the server to your folder of interest, start the server and start the client pointing on the served url.
Principle: the `plant 3d explorer` is a web client that will display in your favorite web browser data exposed by a server (here, romi `plantdb`) on a particular url. The process consists in pointing the server to your folder of interest, starting the server and starting the client that points to the served url.

!!! note: the `plant 3d explorer` has only been developed and tested on Chrome.
!!!note
the `plant 3d explorer` has only been developed and tested on Chrome.

!!! note: if you prefer using docker only, skip steps 1. and 2. and readthe following procedure
!!! note
if you prefer using docker only (to avoid installs), skip steps 1. and 2. and read the following procedure
[Use docker compose to run both database and 3d explorer with docker containers](../docker/docker_compose.md)

### 1. Connect your database to a local server

- Open a terminal
- if romi commands (like `romi_scanner_rest_api`) are not accessible from your terminal, activate the appropriate python environment (e.g. using venv or conda) required for romi commands (or [read this procedure](../install/create_env.md))
- set the DB location using the `DB_LOCATION` environment variable and launch the flask server:
- set the DB location using the `DB_LOCATION` environment variable
- make sure that the
- launch the flask server:
```bash
export DB_LOCATION=/path/to/the/db
romi_scanner_rest_api #command that starts the server
```
The terminal prints various information given by the server (e.g. number of plant phenotyping folder ). Do not

### 2. Connect the `plant 3d explorer `to the server
- Open a new terminal
- go to your local cloned directory of `3d-plantviewer/`
Expand Down

0 comments on commit 7cd35f9

Please sign in to comment.