Skip to content

seequent/lfview-resources-spatial

Repository files navigation

LFView Resources - Spatial

https://readthedocs.org/projects/lfview-resources-spatial/badge/ https://travis-ci.com/seequent/lfview-resources-spatial.svg?branch=master

Warning

The LF View API and all associated Python client libraries are in pre-release. They are subject to change at any time, and backwards compatibility is not guaranteed.

What is lfview-resources-spatial?

This library defines 3D spatial resources in the LF View API. Resources include point sets, line sets, surfaces, and volumes as well as data, textures, and basic display options.

Scope

This library simply includes declarative definitions of spatial resources. It is built on properties to provide type-checking, validation, documentation, and serialization. Very likely, these spatial resources will be used in conjunction with the LF View API Python client.

Installation

You may install this library using pip with

pip install lfview-resources-spatial

or from Github

git clone https://github.com/seequent/lfview-resources-spatial.git
cd lfview-resources-spatial
pip install -e .

You may also just install the LF View API Python client with

pip install lfview-api-client

Either way, after installing, you may access these resources with

from lfview.resources import spatial

points = spatial.ElementPointSet(
    vertices=[[1., 2, 3], [4, 5, 6]],
    data=spatial.DataBasic(
        location='nodes',
        array=[10., 20],
    ),
)