Skip to content

HOWTO.md

Latest commit

 

History

History
136 lines (88 loc) · 6.12 KB

HOWTO.md

File metadata and controls

136 lines (88 loc) · 6.12 KB

README

HOWTO

Caution

Sen2VM core depends on java 8 and gdal version 3.6.2 with java bindings.

Sections:

  • Notebooks are available to users to configure and run Sen2VM in a already installed enviroment §Notebooks
  • These Notebooks are using a Docker ("Sen2VM Docker") with full environment and Sen2VM installed §Sen2VM Docker
  • One that would like to calling Sen2VM in Java could do it (but would be recommended to use the sen2vm-build-end) §Launching using Java
  • How to install sen2vm-build-env docker is also available in section Build env

Tip

Depending on your level of expertise, we recommend using either §Notebooks or Sen2VM Docker. Please note that notebooks are also helping in using output grids.

Thoses levels of usage are linked and can be summaried as below: Environment structure

Also available: §How to compile

1. How to run using Notebooks

TODO link to Notebook Readme

2. How to run within a Docker

  • To build the image, download the Dockerfile from the project root directory and run the following command in the same directory:
docker build . -t sen2vm
  • Launch Sen2vm using the following command:
docker run -it --rm -v [input-data]:[/mounted-name] sen2vm -c [configuration_filepath] [-p [parameters_filepath]]

Caution

-v /NNN:/NNN can be done several time, for example -v /data:/data -v /home/login/working_dir:/home/login/working_dir. This will mount directories inside the docker. All files (input json and folders/files listed in configuration_file) shall be on a mounted disk, if not, the won't be visible

Where:

  • input-data: the input folder
  • configuration_filepath: configuration file containing all inputs related to product or grids that are required by Sen2VM (see §2.1 Configuration file for further information). Please indicate the input paths with absolute path from the docker volume directory (/data in the example above), note that this input is Mandatory.
  • parameters_filepath: file to configure the detectors/bands to process. If not available, all detectors/bands will be processed (see §2.2 Parameters file for further information).This input is Optional.

Note

To understand the configuration, please refer to §2 Inputs

3. How to run using java command

Sen2VM core depends on java 8 and gdal 3.6.2 with java bindings. First, download the jar of Sen2VM core (Sen2VM jar can be downloaded through Releases or Packages pages on GitHub), then run the following command to launch it:

java -jar target/sen2vm-core-<NN.NN.NN>-jar-with-dependencies.jar -c [configuration_filepath] [-p [parameters_filepath]]

Where:

  • <NN.NN.NN> is the version number of Sen2VM launched
  • configuration_filepath: configuration file containing all inputs related to product or grids that are required by Sen2VM (see §2.1 Configuration file for further information). Please note that this input is Mandatory.
  • parameters_filepath: file to configure the detectors/bands to process. If not available, all detectors/bands will be processed (see §2.2 Parameters file for further information).This input is Optional.

To install the java environment, it possible to use the docker build environment. Please refer to §1.5 How to install build environment

Note

Sen2VM core can also be rebuild from sources. Please refer to §1.4 How to compile sen2vm-core

Example from current repository:

java -jar target/sen2vm-core-0.0.1-jar-with-dependencies.jar -c src/test/resources/configuration_example.json -p src/test/resources/params.json

4. How to compile sen2vm-core from sources

Before compiling/installing sen2vm-core, make sure to install the required dependencies. To do so, please refer to https://github.com/sen2vm/sen2vm-build-env/tree/main

Then, inside sen2vm-core folder, run the next commands:

mvn clean install
java -jar target/sen2vm-core-<NN.NN.NN>-jar-with-dependencies.jar -c [configuration_filepath] [-p [parameters_filepath]]

5. How to install build environment

Sen2VM core depends on gdal 3.6.2 with java bindings. A ready to use docker image is available. Please pull the image from here : https://github.com/sen2vm/sen2vm-build-env/pkgs/container/sen2vm-build-env

  • Pull the image:
docker pull ghcr.io/sen2vm/sen2vm-build-env:<tag>
  • Launch the container:
docker run -it --rm --user $UID:$GID -v <sen2vm-core-folder>:/Sen2vm ghcr.io/sen2vm/sen2vm-build-env:latest bash
  • Execute the running java commands inside the opening bash.

README