Getting started
Installation
To install geomdb as an external package, do
pip install .
For development, do
pip install -e ".[dev]"
Unit tests
Note
Running unit tests requires a development install.
To run unit tests, do
pytest -v
The current test results are summarized here.
View/run examples locally
Note
Bootstrapping example notebooks requires a development install.
To bootstrap the example notebooks, do
make notebook
Build documentation locally
Note
Building documentation requires a development install.
To make the documentation, do either
make html
for a static build, or
make livehtml
for a live server with auto-reload.
Notes
The Basic workflow example walks you through the basic workflow:
Create dabase
Deposit data
Query data
Save and reload database
Current capabilities:
Create voxelation from stl file
Select part of the voxelation
Define relations among properties
Dependency resolution among relations
Create data associated with a given location and some relations
Create, manage and query database
Serialize and deserialize database (in fact, any object)