Giter VIP home page Giter VIP logo

geoutils's Introduction

GeoUtils

Set of tools to handle raster and vector data sets in Python.

This package offers Python classes and functions as well as command line tools to work with both geospatial raster and vector datasets. It is built upon rasterio and GeoPandas. In a single command it can import any geo-referenced dataset that is understood by these libraries, complete with all geo-referencing information, various helper functions and interface between vector/raster data.

Installation

  • Create environment and install dependencies

conda env create -f environment.yml

  • Activate environment

conda activate geoutils

  • Install this package

pip install -e . or python setup.py install

  • Check that everything is working by running the tests

pytest -rA

Structure

GeoUtils are composed of three libraries:

  • georaster.py to handle raster data set. In particular, a Raster class to load a raster file along with metadata.
  • geovector.py to handle vector data set. In particular, a Vector class to load a raster file along with metadata.
  • projtools.py with various tools around projections.

How to contribute

You can find ways to improve the libraries in the issues section. All contributions are welcome.

  1. Fork the repository to your personal GitHub account, clone to your computer.
  2. (Optional but preferred:) Make a feature branch.
  3. Push to your feature branch.
  4. When ready, submit a Pull Request from your feature branch to GlacioHack/geoutils:master.
  5. The PR will be reviewed by at least one other person. Usually your PR will be merged via 'squash and merge'.

Direct pushing to the GlacioHack repository is not permitted.

Documentation - please read !

In the interest of keeping the documentation simple, please write all docstring in reStructuredText (https://docutils.sourceforge.io/rst.html) format - eventually, we will try to set up auto-documentation using sphinx and readthedocs, and this will help in that task.

Testing - again please read!

These tools are only valuable if we can rely on them to perform exactly as we expect. So, we need testing. Please create tests for every function that you make, as much as you are able. Guidance/examples here for the moment: https://github.com/GeoUtils/georaster/blob/master/test/test_georaster.py https://github.com/corteva/rioxarray/blob/master/test/integration/test_integration__io.py

geoutils's People

Contributors

atedstone avatar adehecq avatar rhugonnet avatar iamdonovan avatar elischwat avatar erikmannerfelt avatar jlandmann avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.