Skip to content

os-climate/osc-geo-h3grid-srv

Repository files navigation

Important

On June 26 2024, Linux Foundation announced the merger of its financial services umbrella, the Fintech Open Source Foundation (FINOS), with OS-Climate, an open source community dedicated to building data technologies, modeling, and analytic tools that will drive global capital flows into climate change mitigation and resilience; OS-Climate projects are in the process of transitioning to the FINOS governance framework; read more on finos.org/press/finos-join-forces-os-open-source-climate-sustainability-esg

osc-geo-h3grid-srv - Service for Geospatial Temporal Data Mesh

The h3 server is a server designed to allow access to geospatial indices constructed by the osc-geo-h3loader-cli repository. These indices use the H3 mesh developed by Uber to create a uniform grid useful for indexing and comparing data from many different datasets.

The Ecosystem Platform was originally developed by Broda Group Software with key contributions by:

The Geospatial Grid

The h3 geospatial indexing system is an indexing system created by Uber to represent the entire globe. It consists of a series of hexagonal grids that cover the world at different resolution levels.

For more information see the h3 website, or uber's h3 introduction blog

Setting up your Environment

Some environment variables are used by various code and scripts. Set up your environment as follows (note that "source" is used)

source ./bin/environment.sh

It is recommended that a Python virtual environment be created. Several convenience scripts are available to create and activate a virtual environment.

To create a new virtual environment (it will create a directory called "venv" in your current working directory):

$PROJECT_DIR/bin/venv.sh

Once your virtual enviornment has been created, it can be activated as follows (note: you must activate the virtual environment for it to be used, and the command requires "source" to ensure environment variables to support venv are established correctly):

source $PROJECT_DIR/bin/vactivate.sh

Install the required libraries as follows:

pip install -r requirements.txt

Getting started

For a brief overview of how to get started with this application, see the Getting Started Guide.

About the CLIs

To see more information about particular aspects of the geo server, see the below documentation.

This repo offers a command language interface (CLI) to demonstrate this functionality:

  • Geospatial: Query information in the Geospatial Data Mesh
  • Shapefile: Shapefile simplification, statistics, and viewing
  • Repository: Shapefile registration and inventory management

Running tests

(You may need to install pytest)

pytest ./test

Branch Naming Guidelines

Each branch should have an associated github issue. Branches should be named as follows: <branch-type>/issue-<issue number>-<short description>. Where the branch type is one of: [feature, bugfix, hotfix], the issue number is the number of the associated issue, and the short description is a dash ('-') seperated description of the branch's purpose. This to between one and three words if possibble.

Roadmap

For information on planned features, see the roadmap

About

Geospatial Data Mesh: Index Service

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published