Metadata-Version: 2.1
Name: equi7grid
Version: 0.2.2
Summary: Definition and tools for Equi7Grid and its tiling system
Home-page: https://mrs.geo.tuwien.ac.at
Author: TU Wien
Author-email: remote.sensing@geo.tuwien.ac.at
License: mit
Project-URL: Documentation, https://equi7grid.readthedocs.io/
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Description-Content-Type: text/x-rst; charset=UTF-8
Provides-Extra: testing
License-File: LICENSE.txt
License-File: AUTHORS.rst

=========
Equi7Grid
=========

.. image:: https://github.com/TUW-GEO/Equi7Grid/workflows/ubuntu/badge.svg
   :target: https://github.com/TUW-GEO/Equi7Grid/actions/workflows/ubuntu.yml

.. image:: https://github.com/TUW-GEO/Equi7Grid/workflows/windows/badge.svg
   :target: https://github.com/TUW-GEO/Equi7Grid/actions/workflows/windows.yml

.. image:: https://coveralls.io/repos/github/TUW-GEO/Equi7Grid/badge.svg?branch=master
    :target: https://coveralls.io/github/TUW-GEO/Equi7Grid?branch=master

.. image:: https://badge.fury.io/py/Equi7Grid.svg
    :target: https://badge.fury.io/py/Equi7Grid

.. image:: https://readthedocs.org/projects/equi7grid/badge/?version=latest
    :target: https://equi7grid.readthedocs.io/

A python class for working with Equi7Grid - how to convert to - how to use the tiling system - etc.

It's a python package that handles the geometric and geographic operations of a gridded and tiled projection system.
It was designed for data cubes ingesting satellite imagery and builds the basis for the Equi7Grid (see https://github.com/TUW-GEO/Equi7Grid).

A detailed documentation on the Equi7Grid definition is at:

~/docs/doc_files/

Overlays for visualisation in Google Earth can be found here:

~/docs/doc_files/google_earth_overlays/

The 7 projections are completely defined by WKT-strings in the .prj-files at

~/wkt/

or simply by following **proj4-strings**:

.. code::

    AF: '+proj=aeqd +lat_0=8.5 +lon_0=21.5 +x_0=5621452.01998 +y_0=5990638.42298 +datum=WGS84 +units=m +no_defs'
    AN: '+proj=aeqd +lat_0=-90 +lon_0=0 +x_0=3714266.97719 +y_0=3402016.50625 +datum=WGS84 +units=m +no_defs'
    AS: '+proj=aeqd +lat_0=47 +lon_0=94 +x_0=4340913.84808 +y_0=4812712.92347 +datum=WGS84 +units=m +no_defs'
    EU: '+proj=aeqd +lat_0=53 +lon_0=24 +x_0=5837287.81977 +y_0=2121415.69617 +datum=WGS84 +units=m +no_defs'
    NA: '+proj=aeqd +lat_0=52 +lon_0=-97.5 +x_0=8264722.17686 +y_0=4867518.35323 +datum=WGS84 +units=m +no_defs'
    OC: '+proj=aeqd +lat_0=-19.5 +lon_0=131.5 +x_0=6988408.5356 +y_0=7654884.53733 +datum=WGS84 +units=m +no_defs'
    SA: '+proj=aeqd +lat_0=-14 +lon_0=-60.5 +x_0=7257179.23559 +y_0=5592024.44605 +datum=WGS84 +units=m +no_defs'


Citation
========

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1048530.svg
   :target: https://doi.org/10.5281/zenodo.1048530

If you use the software in a publication then please cite it using the Zenodo DOI.
Be aware that this badge links to the latest package version.

Please select your specific version at https://doi.org/10.5281/zenodo.1048530 to get the DOI of that version.
You should normally always use the DOI for the specific version of your record in citations.
This is to ensure that other researchers can access the exact research artefact you used for reproducibility.

You can find additional information regarding DOI versioning at http://help.zenodo.org/#versioning

Installation
============

This package can be installed through pip:

.. code::

    pip install Equi7Grid

Installs for ``scipy`` and ``gdal`` are required from conda or conda-forge (see below how to set up a fresh environment).

Contribute
==========

We are happy if you want to contribute. Please raise an issue explaining what
is missing or if you find a bug. We will also gladly accept pull requests
against our master branch for new features or bug fixes.

Development setup
-----------------

For Development we recommend a ``conda`` environment.

Example installation script
---------------------------

The following script will install a fresh miniconda and setup the environment on a UNIX
like system. In this example, Miniconda will be installed into ``$HOME/miniconda``.

.. code::

    wget https://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh
    bash miniconda.sh -b -p $HOME/miniconda
    export PATH="$HOME/miniconda/bin:$PATH"
    conda config --set always_yes yes --set changeps1 no
    conda update -n base -c defaults conda
    conda install mamba -c conda-forge
    mamba create --name equi7grid_env -c conda-forge python numpy scipy gdal rasterio geopandas cartopy pyproj pip --yes
    conda activate equi7grid_env

This script adds ``$HOME/miniconda/bin`` temporarily to the ``PATH`` to do this
permanently add ``export PATH="$HOME/miniconda/bin:$PATH"`` to your ``.bashrc``
or ``.zshrc``

The last line in the example activates the ``equi7grid_env`` environment.

After you have cloned the package from this repository, you should be able to run:

.. code::

    python setup.py test

to run the test suite,

or alternatively, for convenience, install from pip

.. code::

    pip install Equi7Grid

Guidelines
----------

If you want to contribute please follow these steps:

- Fork the Equi7Grid repository to your account
- Clone the repository
- make a new feature branch from the Equi7Grid master branch
- Add your feature
- Please include tests for your contributions in one of the test directories.
  We use py.test so a simple function called test_my_feature is enough
- submit a pull request to our master branch

Note
====

This project has been set up using PyScaffold 3.3 For details and usage
information on PyScaffold see http://pyscaffold.readthedocs.org/.
