wisdom-oss / nlwkn-rs

📑 Tools for handling water rights data from Niedersachsen's Cadenza database.

NLWKN Toolset

nlwkn-rs

📑 Tools for handling water rights data from Lower Saxony's Cadenza database.

About

nlwkn-rs is a collection of tools aimed at handling water rights data from the "niedersächsischen Landesdatenbank für wasserwirtschaftliche Daten" available at Cadenza. The platform provides an extensive list of active water rights in Lower Saxony, Germany, which can be viewed in a tabular form or visualized on a map.

Project Structure

lib: Contains shared code that all tools utilize. Each tool resides in its own dedicated directory:

• fetcher: Contains the tool to fetch water rights in PDF format from the Cadenza database.

• parser: Houses the tool to parse these PDF reports and enrich them using an XLSX table that can be downloaded from the Cadenza portal.

• adapter: A tool to adapt the data types that nlwkn-rs is working on and reformat it for other tools or people to use.

• exporter: Exporter for the fully parsed water rights into a PostgreSQL database.

For a more detailed overview and instructions specific to each tool, please refer to the README in their respective directories.

Installation and Usage

Prerequisites:

Make sure you have Rust and Cargo installed on your machine. If not, you can get them from rust-lang.org.

Clone the repository:

git clone https://github.com/[your-username]/nlwkn-rs.git
cd nlwkn-rs

Building the project:

cargo build --release

Refer to individual tool directories for usage instructions.

Using nlwkn-rs as a library

Although nlwkn-rs is not available on crates.io, you can still use its types or general common codebase as a library by adding it to your cargo dependencies via the git key.

Add the following to your Cargo.toml file:

[dependencies]
nlwkn-rs = { git = "https://github.com/wisdom-oss/nlwkn-rs.git" }

Disclaimer

This toolset is not officially affiliated with or endorsed by the "niedersächsischen Landesdatenbank für wasserwirtschaftliche Daten" or any related organizations.

nlwkn-rs's Issues

Create PostgreSQL compatible exporter

To be able to use the crawled and parsed data from this project, please create a exporter which is able to write into a PostgreSQL database.

Tip

A dataschema is already defined in https://github.com/wisdom-oss/service-water-rights/blob/feature/updated-dataschema/resources/init.sql which should be used.