Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.6 KB

readme.md

File metadata and controls

39 lines (26 loc) · 1.6 KB
Raw

Resilient Plotter Class

Resilient Plotter Class Logo

A package to create resilient plots for geospatial data. This package is a wrapper around the plotting functionalities of xarray, xugrid, geopandas, contextily and cartopy.

Prerequisites

The following steps are required to install and use the ResilientPlotterClass:

  1. Install Python

  2. Install a python package manager (e.g., Mamba)

  3. Install Git

  4. Install a code editor (e.g. Virtual Studio Code)

Installation

The following steps describe how to install the ResilientPlotterClass as a standalone package:

  1. Clone the ResilientPlotterClass Repository

  2. Create a dedicated environment or use an existing one:

    mamba create --name rpc_env pip ipykernel

  3. Activate the environment:

    mamba activate rpc_env

  4. Install the ResilientPlotterClass:

    pip install -e c:\...\ResilientPlotterClass

Documentation

The documentation for the ResilientPlotterClass is currently only available locally. After cloning the repository, the documation can be found in ResilientPlotterClass/docs/documentation/_build/html/index.html.