Scale Lidar Toolkit

Welcome to Scale's Lidar Toolkit.

The goal of this repository is to provide you with a set of helper functions, examples, and templates to ease the process of transforming your lidar scenes into the Scale API format.

Documentation:

Toolkit Documentation: documentation here.

We've documented the step by step process of using this toolkit with pictures and extensive explations, using the file lidar_template.py as a base.

Scale API Documentation:

This toolkit aids you in getting your data from it's raw format to submitted Scale Tasks ready to be worked on. We have the Scale format documented in full in our 3d documentation. We'd encourage you to use this as a reference for what's possible and what the different options are.

Setup

First things first, ensure you have Pip and Python installed.

Next,

• Run pip3 install -r requirements.txt (to install all the dependencies; pip works equally well to pip3)

• Grab your API key from your Scale Dashboard, we'll want to set that as an enviroment variable (SCALE_API_KEY) in the command line or in a file

• That's it, to pass in your API key and run any script, it will look something like SCALE_API_KEY=live_xxxx python3 <script name>

Optional Setup:

We recommend using AWS S3 to host your Lidar files.

If you plan to use S3, ensure you have the the AWS CLI installed by doing aws --version on the terminal

If you need to install it still, you can check out AWS's guide to Manual AWS-CLI installation

The Lidar toolkit uses boto3 to upload files to s3, this will use aws credentials stored in ~/.aws/credentials.json (profile default). Here's an example of what this file should look like:

[default]
aws_access_key_id = XFSERSDFSS...
aws_secret_access_key = Asjwje1A.....

Do ensure your AWS credentials have permissions to upload files to the BUCKET specified at the top of the script.

Scale File Upload:

Now the lidar toolkit support the new feature Scale File Upload.

More information about Scale File Upload

Usage:

scene.scale_file_upload('project_name')

New release

[0.2.0] - 2022-07-04 - scale-lidar-io-debug

Added

• Add support for reading bs4 files