geetools


Namegeetools JSON
Version 1.3.0 PyPI version JSON
download
home_page
SummaryA collection of tools to work with Google Earth Engine Python API
upload_time2024-03-13 17:28:43
maintainer
docs_urlNone
author
requires_python>=3.9
licenseMIT
keywords earthengine geospatial google-earth-engine python remote-sensing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            geetools
========

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg?logo=opensourceinitiative&logoColor=white
    :target: LICENSE
    :alt: License: MIT

.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?logo=git&logoColor=white
    :target: https://conventionalcommits.org
    :alt: conventional commit

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Black badge

.. image:: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?logo=prettier&logoColor=white
    :target: https://github.com/prettier/prettier
    :alt: prettier badge

.. image:: https://img.shields.io/badge/pre--commit-active-yellow?logo=pre-commit&logoColor=white
    :target: https://pre-commit.com/
    :alt: pre-commit

.. image:: https://img.shields.io/pypi/v/geetools?color=blue&logo=python&logoColor=white
    :target: https://pypi.org/project/geetools/
    :alt: PyPI version

.. image:: https://img.shields.io/conda/vn/conda-forge/geetools?color=blue&logo=anaconda&logoColor=white
    :target: https://anaconda.org/conda-forge/geetools
    :alt: Conda-forge version

.. image:: https://img.shields.io/github/actions/workflow/status/gee-community/geetools/unit.yaml?logo=github&logoColor=white
    :target: https://github.com/gee-community/geetools/actions/workflows/unit.yaml
    :alt: build

.. image:: https://img.shields.io/codecov/c/github/gee-community/geetools?logo=codecov&logoColor=white
    :target: https://codecov.io/gh/gee-community/geetools
    :alt: Test Coverage

.. image:: https://img.shields.io/readthedocs/geetools?logo=readthedocs&logoColor=white
    :target: https://geetools.readthedocs.io/en/stable/
    :alt: Documentation Status

Google Earth Engine tools
-------------------------

.. image:: https://raw.githubusercontent.com/gee-community/geetools/main/docs/_static/logo.svg
    :width: 20%
    :align: right

`Google Earth Engine <https://earthengine.google.com/>`__ is a cloud-based service for geospatial processing of vector and raster data. The Earth Engine platform has a `JavaScript and a Python API <https://developers.google.com/earth-engine/guides>`__ with different methods to process geospatial objects.

The **geetools** package extends the Google Earth Engine Python API with pre-processing and processing tools for the most used satellite platforms by adding utility methods for different Earth Engine Objects that are friendly with the Python method chaining using the ``geetools`` namespace.

There is JavaScript module that you can import from the code editor that has
similar functions (not exactly the same) and it's available `here <https://github.com/fitoprincipe/geetools-code-editor>`__.

Installation
------------

.. code-block:: python

    pip install geetools

Why using it ?
--------------

New utility methods and constructors are added to most of the GEE classes. They can be simple wrapper for repetitive tasks, complex algorithm or mandatory preprocessing steps. The goal is to make the code more fluid and easy to read for researchers, students and analysts.

The package design is mostly performing server-side computation making it also very friendly with commercial users of Earth Engine.

This small example wrapping of the excellent ``ee_extra`` package functionalities shows how to preprocess sentinel 2 data in 5 lines of code:

.. code-block:: python

   import ee
   import geetools #noqa: F401
   import pygaul # another gee-community package to access FAO GAUl 2015 dataset

   # we assume you are already authenticated to GEE
   ee.Initialize.geetools.from_account("toto") # yes we also support multi users

   amazonas = pygaul.Items(name="Amazonas").centroid()

   S2 = (
      ee.ImageCollection('COPERNICUS/S2_SR')
      .filterBounds(point)
      .geetools.closest('2020-10-15') # Extended (pre-processing)
      .geetools.maskClouds(prob = 70) # Extended (pre-processing)
      .geetools.scaleAndOffset() # Extended (pre-processing)
      .geetools.spectralIndices(['NDVI','NDWI','BAIS2'])) # Extended (processing)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "geetools",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "earthengine,geospatial,google-earth-engine,python,remote-sensing",
    "author": "",
    "author_email": "\"Rodrigo E. Principe\" <fitoprincipe82@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/c8/ce/640e44c40cbf3dd1859ec2c299389be81ea7ded76520e950fb6334959e2c/geetools-1.3.0.tar.gz",
    "platform": null,
    "description": "geetools\n========\n\n.. image:: https://img.shields.io/badge/License-MIT-yellow.svg?logo=opensourceinitiative&logoColor=white\n    :target: LICENSE\n    :alt: License: MIT\n\n.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?logo=git&logoColor=white\n    :target: https://conventionalcommits.org\n    :alt: conventional commit\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Black badge\n\n.. image:: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?logo=prettier&logoColor=white\n    :target: https://github.com/prettier/prettier\n    :alt: prettier badge\n\n.. image:: https://img.shields.io/badge/pre--commit-active-yellow?logo=pre-commit&logoColor=white\n    :target: https://pre-commit.com/\n    :alt: pre-commit\n\n.. image:: https://img.shields.io/pypi/v/geetools?color=blue&logo=python&logoColor=white\n    :target: https://pypi.org/project/geetools/\n    :alt: PyPI version\n\n.. image:: https://img.shields.io/conda/vn/conda-forge/geetools?color=blue&logo=anaconda&logoColor=white\n    :target: https://anaconda.org/conda-forge/geetools\n    :alt: Conda-forge version\n\n.. image:: https://img.shields.io/github/actions/workflow/status/gee-community/geetools/unit.yaml?logo=github&logoColor=white\n    :target: https://github.com/gee-community/geetools/actions/workflows/unit.yaml\n    :alt: build\n\n.. image:: https://img.shields.io/codecov/c/github/gee-community/geetools?logo=codecov&logoColor=white\n    :target: https://codecov.io/gh/gee-community/geetools\n    :alt: Test Coverage\n\n.. image:: https://img.shields.io/readthedocs/geetools?logo=readthedocs&logoColor=white\n    :target: https://geetools.readthedocs.io/en/stable/\n    :alt: Documentation Status\n\nGoogle Earth Engine tools\n-------------------------\n\n.. image:: https://raw.githubusercontent.com/gee-community/geetools/main/docs/_static/logo.svg\n    :width: 20%\n    :align: right\n\n`Google Earth Engine <https://earthengine.google.com/>`__ is a cloud-based service for geospatial processing of vector and raster data. The Earth Engine platform has a `JavaScript and a Python API <https://developers.google.com/earth-engine/guides>`__ with different methods to process geospatial objects.\n\nThe **geetools** package extends the Google Earth Engine Python API with pre-processing and processing tools for the most used satellite platforms by adding utility methods for different Earth Engine Objects that are friendly with the Python method chaining using the ``geetools`` namespace.\n\nThere is JavaScript module that you can import from the code editor that has\nsimilar functions (not exactly the same) and it's available `here <https://github.com/fitoprincipe/geetools-code-editor>`__.\n\nInstallation\n------------\n\n.. code-block:: python\n\n    pip install geetools\n\nWhy using it ?\n--------------\n\nNew utility methods and constructors are added to most of the GEE classes. They can be simple wrapper for repetitive tasks, complex algorithm or mandatory preprocessing steps. The goal is to make the code more fluid and easy to read for researchers, students and analysts.\n\nThe package design is mostly performing server-side computation making it also very friendly with commercial users of Earth Engine.\n\nThis small example wrapping of the excellent ``ee_extra`` package functionalities shows how to preprocess sentinel 2 data in 5 lines of code:\n\n.. code-block:: python\n\n   import ee\n   import geetools #noqa: F401\n   import pygaul # another gee-community package to access FAO GAUl 2015 dataset\n\n   # we assume you are already authenticated to GEE\n   ee.Initialize.geetools.from_account(\"toto\") # yes we also support multi users\n\n   amazonas = pygaul.Items(name=\"Amazonas\").centroid()\n\n   S2 = (\n      ee.ImageCollection('COPERNICUS/S2_SR')\n      .filterBounds(point)\n      .geetools.closest('2020-10-15') # Extended (pre-processing)\n      .geetools.maskClouds(prob = 70) # Extended (pre-processing)\n      .geetools.scaleAndOffset() # Extended (pre-processing)\n      .geetools.spectralIndices(['NDVI','NDWI','BAIS2'])) # Extended (processing)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A collection of tools to work with Google Earth Engine Python API",
    "version": "1.3.0",
    "project_urls": {
        "Homepage": "https://github.com/gee-community/geetools"
    },
    "split_keywords": [
        "earthengine",
        "geospatial",
        "google-earth-engine",
        "python",
        "remote-sensing"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cb48ba6e507a2cb7de3352b15c0ecd469bfed7d58226de54a8868759c9ee2339",
                "md5": "bc4ef0b519d3d2bb54931313f69e8a26",
                "sha256": "d26f5c280b7087a2614e287d179e1dc3409abe2890cca360a7798add4a29c064"
            },
            "downloads": -1,
            "filename": "geetools-1.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bc4ef0b519d3d2bb54931313f69e8a26",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 103055,
            "upload_time": "2024-03-13T17:28:41",
            "upload_time_iso_8601": "2024-03-13T17:28:41.484108Z",
            "url": "https://files.pythonhosted.org/packages/cb/48/ba6e507a2cb7de3352b15c0ecd469bfed7d58226de54a8868759c9ee2339/geetools-1.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c8ce640e44c40cbf3dd1859ec2c299389be81ea7ded76520e950fb6334959e2c",
                "md5": "23653cb1e2727e0d777e378bbda808e1",
                "sha256": "4b8367370c1df89bc90adc7921027a4dc8dc878c5c300762f0ee332c7a5c6536"
            },
            "downloads": -1,
            "filename": "geetools-1.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "23653cb1e2727e0d777e378bbda808e1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 1813800,
            "upload_time": "2024-03-13T17:28:43",
            "upload_time_iso_8601": "2024-03-13T17:28:43.891195Z",
            "url": "https://files.pythonhosted.org/packages/c8/ce/640e44c40cbf3dd1859ec2c299389be81ea7ded76520e950fb6334959e2c/geetools-1.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-13 17:28:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "gee-community",
    "github_project": "geetools",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "geetools"
}
        
Elapsed time: 0.21291s