Project autk-db

Expand description

Autark: A portable UTK-based visualization framework

Autark Logo

Autark is implemented in TypeScript for lightweight client-side execution with built-in access to OpenStreetMap geometry data for exploring spatial features directly in the browser. It consists of the following sub-projects:

  • autk-db: A spatial database that handles physical and thematic urban datasets.
  • autk-map: A 3D map visualization library.
  • autk-plot: A D3.js/Vega-lite wrapper to build abstract visualizations.

The example/ directory is included with example codes that can be used for testing or demonstration purposes.

You’ll need Node.js installed to build and run this project. You can install it via Conda Forge (Windows), Homebrew (macOS), apt-get (Debian/Ubuntu) or the official site.

To install Node.js:

# Windows
conda install -c conda-forge nodejs

# macOS
brew install node

# Debian/Ubuntu
sudo apt-get install nodejs

Install Make (for running predefined build and dev commands):

# Windows
conda install anaconda::make

# macOS
xcode-select --install

# Debian/Ubuntu
sudo apt-get install build-essential

To install required packages:

make install

To run the development server:

make dev

To clean build artifacts:

make clean

Autark is available through npm packages. Publishing recently-made changes to npm can be done running the commands below.

First, ensure you are logged into your npm account:

npm login 

then, publish the desired module:

make publish LIB=autk-module 

autk-module can assume three values: autk-map, autk-db, autk-plot.


You can explore and modify the map using both keyboard and mouse:

Key Action
s Cycle through map styles (default, light, dark)
Action Effect
Double Click Select object in the currently active layer (if selectable)

  • WebGPU is required to run this project. In Chrome or Edge (v113+), it's enabled by default. In Firefox, WebGPU is only available in Nightly builds and must be explicitly enabled::

    1. Download and install Firefox Nightly.
    2. Visit about:config.
    3. Set dom.webgpu.enabled to true.
    4. (Optional) You may also need to enable gfx.webgpu.enabled and gfx.webgpu.force-enabled.
    5. Restart Firefox.

Classes§

SpatialDb

SpatialDb class provides methods to interact with a DuckDB database for spatial data operations.

Interfaces§

Layer