Metadata-Version: 2.1
Name: earthpy
Version: 0.6.10
Summary: A set of helper functions to make working with spatial data in open source tools easier. This package is maintained by Earth Lab and was originally designed to support the earth analytics education program.
Home-page: https://github.com/earthlab/earthpy
Maintainer: Leah Wasser
Maintainer-email: leah.wasser@colorado.edu
License: UNKNOWN
Description: [![DOI](https://zenodo.org/badge/122149160.svg)](https://zenodo.org/badge/latestdoi/122149160)
        [![Build Status](https://travis-ci.org/earthlab/earthpy.svg?branch=master)](https://travis-ci.org/earthlab/earthpy)
        [![Build status](https://ci.appveyor.com/api/projects/status/xgf5g4ms8qhgtp21?svg=true)](https://ci.appveyor.com/project/earthlab/earthpy)
        [![codecov](https://codecov.io/gh/earthlab/earthpy/branch/master/graph/badge.svg)](https://codecov.io/gh/earthlab/earthpy)
        [![Docs build](https://readthedocs.org/projects/earthpy/badge/?version=latest)](https://earthpy.readthedocs.io/en/latest/?badge=latest)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://img.shields.io/badge/code%20style-black-000000.svg)
        
        # EarthPy
        
        ![PyPI](https://img.shields.io/pypi/v/earthpy.svg?color=purple&style=plastic)
        ![PyPI - Downloads](https://img.shields.io/pypi/dm/earthpy.svg?color=purple&label=pypi%20downloads&style=plastic)
        ![Conda](https://img.shields.io/conda/v/conda-forge/earthpy.svg?color=purple&style=plastic)
        ![Conda](https://img.shields.io/conda/dn/conda-forge/earthpy.svg?color=purple&label=conda-forge%20downloads&style=plastic)
        
        EarthPy is makes it easier to plot and manipulate spatial data in Python.
        
        ## Why EarthPy?
        
        Python is a generic programming language designed to support many different applications. Because of this, many commonly
        performed spatial tasks for science including plotting and working with spatial data take many steps of code. EarthPy 
        takes advantage of functionality developed for raster data (rasterio) and vector data (geopandas) and simplifies the 
        code needed to :
        
        * [Stack raster bands from data such as Landsat into an easy to use numpy array](https://earthpy.readthedocs.io/en/latest/gallery_vignettes/plot_raster_stack_crop.html)
        * [Work with masks to set bad pixels such a those covered by clouds and cloud-shadows to NA (`mask_pixels()`)](https://earthpy.readthedocs.io/en/latest/gallery_vignettes/plot_stack_masks.html#sphx-glr-gallery-vignettes-plot-stack-masks-py)
        * [Plot rgb (color), color infrared and other 3 band combination images (`plot_rgb()`)](https://earthpy.readthedocs.io/en/latest/gallery_vignettes/plot_rgb.html)
        * [Plot bands of a raster quickly using `plot_bands()`](https://earthpy.readthedocs.io/en/latest/gallery_vignettes/plot_bands_functionality.html)
        * View histograms of sets of raster 
        * [Create discrete (categorical) legends](https://earthpy.readthedocs.io/en/latest/gallery_vignettes/plot_draw_legend_docs.html)
        * [Crop raster bands to a study area]((https://earthpy.readthedocs.io/en/latest/gallery_vignettes/plot_raster_stack_crop.html))
        * [Calculate vegetation indices such as Normalized Difference Vegetation Index (`normalized_diff()`)](https://earthpy.readthedocs.io/en/latest/gallery_vignettes/plot_calculate_classify_ndvi.html)
        * [Create hillshade from a DEM](https://earthpy.readthedocs.io/en/latest/gallery_vignettes/plot_dem_hillshade.html)
        
        EarthPy also has an io module that allows users to 
        
        1. Quickly access pre-created datasubsets used in the earth-analytics courses hosted 
        on [www.earthdatascience.org](https://www.earthdatascience.org) 
        2. Download other datasets that they may want to use in their workflows.
        
        ## View Example EarthPy Applications in Our Documentation Gallery  
        
        Check out our [vignette gallery](https://earthpy.readthedocs.io/en/latest/gallery_vignettes/index.html) for 
        applied examples of using EarthPy in common spatial workflows. 
        
        ## Install
        
        To install, use `pip` or `conda-forge`. We encourage you to use `conda-forge` if you are a conda users. 
        
        ### Install via Pip
        
        To install EarthPy via `pip` use:
        
        ```bash
        $ pip install --upgrade earthpy
        ```
        
        ### Install Using Conda / conda-forge Channel
        
        If you are working within an Anaconda environment, we suggest that you install EarthPy using 
        `conda-forge`
        
        ```bash
        $ conda install -c conda-forge earthpy
        ```
        
        Note: if you want to set conda-forge as your default conda channel, you can use the following install workflow.
        We recommmend this approach. Once you have run conda config, you can install earthpy without specifying a channel.
        
        ```bash
        $ conda config --add channels conda-forge
        $ conda install earthpy
        ```
        
        
        Once you have successfully installed EarthPy, you can import it into Python.
        
        ```python
        >>> import earthpy as et
        ```
        
        Below is a quick example of plotting multiple bands in a numpy array format.
        
        ```python
        >>> arr = np.random.randint(4, size=(3, 5, 5))
        >>> ep.plot_bands(arr, titles=["Band 1", "Band 2", "Band 3"])
        >>> plt.show()
        ```
        
        ## Active Contributors
        
        We welcome contributions to EarthPy. Below are the current active package maintainers. Please see our
        [contributors file](https://earthpy.readthedocs.io/en/latest/contributors.html) for a complete list of all 
        of our contributors.
        
        
        <a title="Leah Wasser" href="https://www.github.com/lwasser"><img width="60" height="60" alt="Leah Wasser" class="pull-left" src="https://avatars.githubusercontent.com/u/7649194?size=120" /></a>
        <a title="Max Joseph" href="https://www.github.com/mbjoseph"><img width="60" height="60" alt="Max Joseph" class="pull-left" src="https://avatars.githubusercontent.com/u/2664564?size=120" /></a>
        <a title="Joseph McGlinchy" href="https://www.github.com/joemcglinchy"><img width="60" height="60" alt="Joseph McGlinchy" class="pull-left" src="https://avatars.githubusercontent.com/u/4762214?size=120" /></a>
        <a title="Jenny Palomino" href="https://www.github.com/jlpalomino"><img width="60" height="60" alt="Jenny Palomino" class="pull-left" src="https://avatars.githubusercontent.com/u/4017492?size=120" /></a>
        <a title="Nathan Korinek" href="https://www.github.com/nkorinek"><img width="60" height="60" alt="Nathan Korinek" class="pull-left" src="https://avatars.githubusercontent.com/u/38253680?size=120" /></a>
        <a title="Tim Head" href="https://www.github.com/betatim"><img width="60" height="60" alt="Tim Head" class="pull-left" src="https://avatars.githubusercontent.com/u/1448859?size=120" /></a>
        <a title="Michelle Roby" href="https://www.github.com/mirob9363"><img width="60" height="60" alt="Michelle Roby" class="pull-left" src="https://avatars.githubusercontent.com/u/42818395?size=120" /></a>
        
        
        ## How to Contribute
        
        We welcome contributions to EarthPy! Please be sure to check out our 
        [contributing guidelines](https://earthpy.readthedocs.io/en/latest/contributing.html)
        for more information about submitting pull requests or changes to EarthPy. 
        
        ## License
        
        [BSD-3](https://github.com/earthlab/earthpy/blob/master/LICENSE)
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Description-Content-Type: text/markdown
