Skip to content
A package built to support working with spatial data using open source python
Python TeX Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Dec 18, 2018
.travis Add testing for OSX on Travis CI Mar 22, 2019
docs Bump version: 0.7.6 → 0.8.0 Nov 13, 2019
earthpy Modify Hillshade argument names to add consistency (#438) Oct 25, 2019
examples Update per black (#425) Oct 28, 2019
.gitignore PR review edits Apr 1, 2019
.pre-commit-config.yaml
.travis.yml fix black and also badge order on readme (#452) Nov 7, 2019
.zenodo.json Add contributor type to zenodo.json (#447) Oct 28, 2019
CHANGELOG.md changelog update Nov 13, 2019
CODE_OF_CONDUCT.md
CONTRIBUTING.rst cleanup pr with readme and contributing edits following pyopensci rev… Oct 28, 2019
CONTRIBUTORS.rst Readme Updates (#304) Apr 11, 2019
LICENSE adding BSD license Dec 19, 2018
MANIFEST.in Use a MANIFEST.in file to distribute the LICENSE and README Mar 28, 2019
Makefile
README.md Suggested updates to README (#456) Nov 13, 2019
appveyor.yml fix appveyor fail by installing earthpy without the deps (#422) Sep 13, 2019
dev-requirements.txt fix black and also badge order on readme (#452) Nov 7, 2019
environment.yml Merge branch 'master' into stdlib-downloads Mar 18, 2019
paper.bib updating bib file Nov 11, 2019
paper.md Finalize edits for JOSS review (#455) Nov 13, 2019
pyproject.toml Configure black's line length to 79 Dec 16, 2018
readthedocs.yml Fail on warning to catch import errors Mar 25, 2019
setup.cfg Bump version: 0.7.6 → 0.8.0 Nov 13, 2019
setup.py Bump version: 0.7.6 → 0.8.0 Nov 13, 2019
tox.ini fix black and also badge order on readme (#452) Nov 7, 2019

README.md

DOI pyOpenSci Build Status Build status codecov Docs build Code style: black

EarthPy

PyPI PyPI - Downloads Conda Conda

EarthPy 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 builds upon the functionality developed for raster data (rasterio) and vector data (geopandas) in Python and simplifies the code needed to:

EarthPy also has an io module that allows users to

  1. Quickly access pre-created data subsets used in the earth-analytics courses hosted on www.earthdatascience.org
  2. Download other datasets that they may want to use in their workflows.

EarthPy's design was inspired by the raster and sp package functionality available to R users.

View Example EarthPy Applications in Our Documentation Gallery

Check out our vignette gallery for applied examples of using EarthPy in common spatial workflows.

Install

EarthPy can be installed using pip, but we strongly recommend that you install it using conda and the conda-forge channel.

Install Using Conda / conda-forge Channel (Preferred)

If you are working within an Anaconda environment, we suggest that you install EarthPy using conda-forge

$ 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.

$ conda config --add channels conda-forge
$ conda install earthpy

Install via Pip

EarthPy uses the rtree package for some of its operations which depends upon libspatialindex. This package can be challenging to install using pip whereas it will automagically be installed if you use conda.

To install EarthPy via pip use:

$ pip install --upgrade earthpy

Once you have successfully installed EarthPy, you can import it into Python.

>>> import earthpy.plot as ep

Below is a quick example of plotting multiple bands in a numpy array format.

>>> arr = np.random.randint(4, size=(3, 5, 5))
>>> ep.plot_bands(arr, titles=["Band 1", "Band 2", "Band 3"])
>>> plt.show()

Active Maintainers

We welcome contributions to EarthPy. Below are the current active package maintainers. Please see our contributors file for a complete list of all of our contributors.

Leah Wasser Max Joseph Joseph McGlinchy Jenny Palomino Nathan Korinek

Contributors

We've welcome any and all contributions. Below are some of the contributors to EarthPy. We are currently trying to update this list!!

Michelle Roby Tim Head Michelle Roby Michelle Roby

How to Contribute

We welcome contributions to EarthPy! Please be sure to check out our contributing guidelines for more information about submitting pull requests or changes to EarthPy.

License & Citation

BSD-3

Citation Information

When citing EarthPy, please cite our JOSS paper:

@article{Wasser2019EarthPy,
	journal = {Journal of Open Source Software},
	doi = {10.21105/joss.01886},
	issn = {2475-9066},
	number = {43},
	publisher = {The Open Journal},
	title = {EarthPy: A Python package that makes it easier to explore and plot raster and vector data using open source Python tools.},
	url = {https://doi.org/10.21105/joss.01886},
	volume = {4},
	author = {Wasser, Leah and Joseph, Maxwell and McGlinchy, Joe and Palomino, Jenny and Korinek, Nathan and Holdgraf, Chris and Head, Tim},
	pages = {1886},
	date = {2019-11-13},
	year = {2019},
	month = {11},
	day = {13},
}

You can’t perform that action at this time.