mirror of
https://github.com/rasterio/rasterio.git
synced 2025-12-08 17:36:12 +00:00
round of edits per pr review
This commit is contained in:
Matthew Perry
parent
ead10a0c5a
commit
eba34a32cf
60
AUTHORS.txt
60
AUTHORS.txt
@ -1,34 +1,34 @@
|
||||
Authors
|
||||
=======
|
||||
-------
|
||||
|
||||
Aldo Culquicondor <alculquicondor@gmail.com>
|
||||
Alessandro Amici <alexamici@gmail.com>
|
||||
Alexander <spatial.hast@gmail.com>
|
||||
Amit Kapadia <amit@planet.com>
|
||||
AsgerPetersen <asgerpetersen@gmail.com>
|
||||
Bas Couwenberg <sebastic@xs4all.nl>
|
||||
Brendan Ward <bcward@consbio.org>
|
||||
Etienne B. Racine <etiennebr@gmail.com>
|
||||
Even Rouault <even.rouault@spatialys.com>
|
||||
Jacques Tardie <hi@jacquestardie.org>
|
||||
James McBride <jmcbride@berkeley.edu>
|
||||
James Seppi <james.seppi@gmail.com>
|
||||
Jeffrey Gerard <jgerard@climate.com>
|
||||
Johan Van de Wauw <johan.vandewauw@gmail.com>
|
||||
Joshua Arnott <josh@snorfalorpagus.net>
|
||||
Kelsey Jordahl <kjordahl@alum.mit.edu>
|
||||
Kevin Wurster <wursterk@gmail.com>
|
||||
Martijn Visser <mgvisser@gmail.com>
|
||||
Matt Savoie <github@flamingbear.com>
|
||||
Matthew Perry <perrygeo@gmail.com>
|
||||
Maxim Dubinin <sim@gis-lab.info>
|
||||
Mike Toews <mwtoews@gmail.com>
|
||||
Nat Wilson <njwilson23@gmail.com>
|
||||
Patrick Young <patrick.young@digitalglobe.com>
|
||||
Robin Wilson <robin@rtwilson.com>
|
||||
Ryan Grout <rgrout@continuum.io>
|
||||
Sean Gillies <sean@mapbox.com>
|
||||
Trevor R.H. Clarke <tclarke@ball.com>
|
||||
cgohlke <cgohlke@uci.edu>
|
||||
* Aldo Culquicondor <alculquicondor@gmail.com>
|
||||
* Alessandro Amici <alexamici@gmail.com>
|
||||
* Alexander <spatial.hast@gmail.com>
|
||||
* Amit Kapadia <amit@planet.com>
|
||||
* AsgerPetersen <asgerpetersen@gmail.com>
|
||||
* Bas Couwenberg <sebastic@xs4all.nl>
|
||||
* Brendan Ward <bcward@consbio.org>
|
||||
* Etienne B. Racine <etiennebr@gmail.com>
|
||||
* Even Rouault <even.rouault@spatialys.com>
|
||||
* Jacques Tardie <hi@jacquestardie.org>
|
||||
* James McBride <jmcbride@berkeley.edu>
|
||||
* James Seppi <james.seppi@gmail.com>
|
||||
* Jeffrey Gerard <jgerard@climate.com>
|
||||
* Johan Van de Wauw <johan.vandewauw@gmail.com>
|
||||
* Joshua Arnott <josh@snorfalorpagus.net>
|
||||
* Kelsey Jordahl <kjordahl@alum.mit.edu>
|
||||
* Kevin Wurster <wursterk@gmail.com>
|
||||
* Martijn Visser <mgvisser@gmail.com>
|
||||
* Matt Savoie <github@flamingbear.com>
|
||||
* Matthew Perry <perrygeo@gmail.com>
|
||||
* Maxim Dubinin <sim@gis-lab.info>
|
||||
* Mike Toews <mwtoews@gmail.com>
|
||||
* Nat Wilson <njwilson23@gmail.com>
|
||||
* Patrick Young <patrick.young@digitalglobe.com>
|
||||
* Robin Wilson <robin@rtwilson.com>
|
||||
* Ryan Grout <rgrout@continuum.io>
|
||||
* Sean Gillies <sean@mapbox.com>
|
||||
* Trevor R.H. Clarke <tclarke@ball.com>
|
||||
* cgohlke <cgohlke@uci.edu>
|
||||
|
||||
See also https://github.com/mapbox/rasterio/graphs/contributors.
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
# Contributor Code of Conduct
|
||||
Contributor Code of Conduct
|
||||
---------------------------
|
||||
|
||||
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
|
||||
|
||||
@ -19,4 +20,6 @@ This code of conduct applies both within project spaces and in public spaces whe
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
|
||||
This Code of Conduct is adapted from the `Contributor Covenant`_, version 1.2.0, available at http://contributor-covenant.org/version/1/2/0/
|
||||
|
||||
.. _Contributor Covenant: http://contributor-covenant.org
|
||||
@ -5,11 +5,13 @@ Community
|
||||
.. todo::
|
||||
|
||||
This is just a placeholder page to explain the use and development of rasterio.
|
||||
|
||||
|
||||
If you have a project that uses rasterio, please contact us at https://github.com/mapbox/rasterio/issues
|
||||
|
||||
Who is using rasterio?
|
||||
----------------------
|
||||
|
||||
* The `Conservation Biology Institute`_ uses rasterio to provide `geoprocessing of NetCDF files`_.
|
||||
* `Mapbox`_ uses rasterio to process satellite imagery for it's global satellite base maps.
|
||||
* Mary Marek-Spartz's masters thesis compares the map algebra tools of the proprietary ESRI ArcPy library and the open source Rasterio library. https://github.com/alfalimajuliett/masters-thesis
|
||||
|
||||
@ -26,12 +28,6 @@ Rio plugins
|
||||
|
||||
In addition to the core ``rio`` commands, visit the `Rio plugin registry`_ for a list of external plugins.
|
||||
|
||||
|
||||
Code of conduct
|
||||
---------------
|
||||
|
||||
.. include:: ../CODE_OF_CONDUCT.md
|
||||
|
||||
|
||||
Who are the rasterio developers?
|
||||
--------------------------------
|
||||
@ -39,5 +35,9 @@ Who are the rasterio developers?
|
||||
.. include:: ../AUTHORS.txt
|
||||
|
||||
|
||||
.. include:: ../CODE_OF_CONDUCT.txt
|
||||
|
||||
.. _Mapbox: https://mapbox.com
|
||||
.. _Rio plugin registry: https://github.com/mapbox/rasterio/wiki/Rio-plugin-registry
|
||||
.. _Conservation Biology Institute: http://consbio.org/
|
||||
.. _geoprocessing of NetCDF files: https://github.com/consbio/clover
|
||||
|
||||
13
docs/conf.py
13
docs/conf.py
@ -63,10 +63,15 @@ author = u'Sean Gillies'
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = u'1.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = u'1.0'
|
||||
# Parse the version from the rasterio module.
|
||||
with open('../rasterio/__init__.py') as f:
|
||||
for line in f:
|
||||
if line.find("__version__") >= 0:
|
||||
version = line.split("=")[1].strip()
|
||||
version = version.strip('"')
|
||||
version = version.strip("'")
|
||||
continue
|
||||
release = version
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
||||
@ -1,3 +1,13 @@
|
||||
=================
|
||||
Rasterio Cookbook
|
||||
=================
|
||||
|
||||
.. todo::
|
||||
|
||||
Examples of using rasterio to handle tasks from typical
|
||||
GIS and remote sensing workflows.
|
||||
|
||||
With inspiration from
|
||||
|
||||
* https://pcjericks.github.io/py-gdalogr-cookbook/
|
||||
* https://github.com/dwtkns/gdal-cheat-sheet
|
||||
|
||||
@ -5,3 +5,11 @@ Developers guide
|
||||
|
||||
Everything developers need to know to get a dev environment running,
|
||||
run tests, modify code and submit a successful PR.
|
||||
|
||||
Currently most of this information lives on the wiki.
|
||||
|
||||
* https://github.com/mapbox/rasterio/wiki/Development-Guide
|
||||
* https://github.com/mapbox/rasterio/wiki/Exposing-GDAL-Functionality
|
||||
* https://github.com/mapbox/rasterio/wiki/Cython-and-GDAL
|
||||
|
||||
The long term goal is to consolidate into this document.
|
||||
|
||||
@ -1,15 +1,10 @@
|
||||
.. rasterio documentation master file, created by
|
||||
sphinx-quickstart on Thu Mar 17 07:05:00 2016.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Rasterio Documentation
|
||||
======================
|
||||
|
||||
.. warning::
|
||||
This is not the official documentation. Not yet.
|
||||
This is a draft and everything here is subject to change.
|
||||
|
||||
This is a draft and everything here is subject to change.
|
||||
|
||||
For now, please refer to https://github.com/mapbox/rasterio
|
||||
for documentation.
|
||||
|
||||
@ -20,19 +15,19 @@ Rasterio employs GDAL_ under the hood for file I/O and raster formatting.
|
||||
Its functions typically accept and return Numpy ndarrays.
|
||||
Rasterio is designed to make working with geospatial raster data more productive and more fun.
|
||||
|
||||
You can download from pypi and todo quick link to install
|
||||
Install with pip (see the complete :doc:`installation docs </installation>` )
|
||||
|
||||
.. code::
|
||||
|
||||
pip install rasterio
|
||||
|
||||
And a quick example
|
||||
And an example of use in python
|
||||
|
||||
.. code::
|
||||
.. code:: python
|
||||
|
||||
import rasterio
|
||||
with rasterio.open('data.tif') as src:
|
||||
array = src.read()
|
||||
array = src.read()
|
||||
|
||||
|
||||
Contents:
|
||||
@ -46,7 +41,6 @@ Contents:
|
||||
community
|
||||
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
Introduction
|
||||
=============
|
||||
|
||||
|
||||
@ -21,6 +21,6 @@ This user's manual is for Python developers who want a clean API for accessing r
|
||||
working_with_datasets
|
||||
writing
|
||||
topics
|
||||
osgeo_gdal_migration
|
||||
developers
|
||||
cookbook
|
||||
osgeo_gdal_migration
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
Topics
|
||||
======
|
||||
General Concepts
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user