Skip to content

Latest commit

 

History

History
121 lines (87 loc) · 6.34 KB

README.md

File metadata and controls

121 lines (87 loc) · 6.34 KB
Raw

up42-storage

Storage block for integrating data with UP42 Platform

Introduction

The block enables UP42 users to run processing algorithms on top of their data. The concept of the block came from the case where Cars Detection algorithm should have been run on previously acquired imagery for further visualization and processing in Aspectum.

Requirements

This example requires the Mac or Ubuntu bash. In order to bring this example block or your own custom block to the UP42 platform the following tools are required:

Instructions

Clone the repository

git clone https://github.com/aspectumapp/up42-storage.git

Then navigate to the folder via cd up42-storage.

Set up parameters

To use the block you should provide your AWS credentials. Open the Makefile. Edit the code below by inserting your AWS credentials:

AWS_ACCESS_KEY := XXXXXXXXXXXXXXXXXX
AWS_SECRET_ACCESS_KEY := XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
AWS_REGION := us-east-1
AWS_BUCKET_NAME := your-bucket-name-with-files

Pushing the block to the UP42 platform

First login to the UP42 docker registry. [email protected] needs to be replaced by your UP42 username, which is the email address you use on the UP42 website.

make login [email protected]

In order to push the block to the UP42 platform, you need to build the block Docker container with your UP42 USER-ID. To get your USER-ID, go to the UP42 custom-blocks menu. Click on "PUSH a BLOCK to THE PLATFORM" and copy your USERID from the command shown on the last line at "Push the image to the UP42 Docker registry". The USERID will look similar to this: 63uayd50-z2h1-3461-38zq-1739481rjwia

Pass the USER-ID to the build command:

make build UID=<UID>

# As an example: make build UID=63uayd50-z2h1-3461-38zq-1739481rjwia

Now you can finally push the image to the UP42 docker registry, again passing in your USER-ID:

make push UID=<UID>

# As an example: make push UID=63uayd50-z2h1-3461-38zq-1739481rjwia

Success! The block will now appear in the UP42 custom blocks menu menu and can be selected under the Custom blocks tab when building a workflow.

Optional: Updating an existing custom block

If you want to update a custom block on UP42, you need to build the Docker container with an updated version: The default docker tag is up42-storage and the version is set to latest.

make build UID=<UID> DOCKER_TAG=<docker tag> DOCKER_VERSION=<docker version>

# As an example: make build UID=63uayd50-z2h1-3461-38zq-1739481rjwia DOCKER_TAG=up42-storage DOCKER_VERSION=1.0

Then push the block container with the updated tag and version:

make push UID=<UID> DOCKER_TAG=<docker tag> DOCKER_VERSION=<docker version>

# As an example: make push UID=63uayd50-z2h1-3461-38zq-1739481rjwia DOCKER_TAG=up42-storage DOCKER_VERSION=1.0

Using the block

  1. To use the block in UP42 Platform, you should provide the filename of the imagery stored on the bucket in the file_path parameter.

  2. Choose any Bounding Box. This parameter does not crop the image. The whole file on the S3 would be moved for the next step.

  3. Run the job! Now your file has been used as an input for the following processing and/or visualization. Important: The imagery should be in EPSG:3857 coordinate system. For transforming the coordinate system of geotiff you could use GIS software: QGIS or ArcGIS examples.

Run block locally: Installing the required libraries

First create a new virtual environment called up42-aws, for example by using virtualenvwrapper:

mkvirtualenv --python=$(which python3.7) up42-aws

Activate the new environment:

workon up42-aws

Install the necessary Python libraries via:

make install