Skip to content

Commit 3eaadab

Browse files
committed
bump version and update README/setup.py
1 parent 79568c3 commit 3eaadab

File tree

4 files changed

+119
-65
lines changed

4 files changed

+119
-65
lines changed

README.md

Lines changed: 22 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,14 @@
33
[![Build Status](https://travis-ci.org/fortyninemaps/karta.svg?branch=master)](https://travis-ci.org/fortyninemaps/karta)
44

55
*Karta* is a package for spatial analysis in Python. It streamlines data
6-
processing by providing generic geographical types for vector and raster sources
7-
as well as a selection of analysis functions.
6+
processing by providing efficient generic geographical types for vector and
7+
raster sources as well as a selection of analysis functions.
88

99
For example, read or create vector geometries:
1010

1111
```python
1212
point = Point((-130.0, 52.0), crs=LonLatWGS84)
13-
1413
line = read_geojson("linedata.json")
15-
1614
polygon = Polygon([(-515005.78, -1301130.53),
1715
(-579174.89, -1282271.94),
1816
(-542977.83, -1221147.82),
@@ -25,42 +23,33 @@ Perform simple queries:
2523
```python
2624
point2 = Point((-25.0, 48.0), crs=LonLatWGS84)
2725
point.distance(point2) # Distance in geographical units
28-
2926
line.intersects(polygon) # True or False
30-
3127
ch = polygon.convex_hull() # Returns a new polygon
3228
ch.to_shapefile("poly.shp")
3329
```
3430
Load and manipulate raster data:
3531
```python
3632
grid = read_gtiff("landsat_scene.tif") # Leverages GDAL
37-
3833
grid.profile(line) # Collect data along a line
39-
4034
grid.resample(500.0, 500.0) # Return a grid resampled at a new resolution
4135
```
4236

43-
The latest release is on PyPI (see [Installation](#installation)). *Karta* is
44-
tested with Python 2.7 and Python 3.4+. Suggestions, bug reports, test cases,
45-
and pull requests are welcome.
37+
The latest release is on PyPI (see [Installation](#installation)). Suggestions,
38+
bug reports, test cases, and pull requests are welcome.
4639

47-
The latest stable release is 0.6.1. The repository master branch is considered
48-
an moderately-unstable development version.
40+
The latest stable release is 0.7. The repository master branch is considered a
41+
moderately-unstable development branch.
4942

50-
## DOCUMENTATION
43+
## Documentation
5144

5245
See the [online manual](http://www.fortyninemaps.com/kartadocs/introduction.html),
5346
the [tutorial](http://www.fortyninemaps.com/kartadocs/_static/tutorial.html), or read the
5447
[API documentation](http://www.fortyninemaps.com/kartadocs/reference.html).
5548

56-
The manual can also be built offline using Sphinx by running `make` from the
57-
`doc/` subdirectory. The documentation is built from source code docstrings and
58-
the example IPython notebooks, which are also reproduced in the
59-
[Wiki](https://github.com/fortyninemaps/karta/wiki/Tutorial). Building the
60-
documentation requires [Sphinx](http://sphinx-doc.org/) and
61-
[numpydoc](https://github.com/numpy/numpydoc).
49+
The manual can be built offline using [Sphinx](http://sphinx-doc.org/). Building
50+
the documentation requires [numpydoc](https://github.com/numpy/numpydoc).
6251

63-
## PACKAGE OVERVIEW
52+
## Package Overview
6453

6554
- **karta.crs**: framework for coordinate reference systems and geodetic
6655
calculations
@@ -75,7 +64,7 @@ documentation requires [Sphinx](http://sphinx-doc.org/) and
7564

7665
- **tests**: unit tests, to be run with `python tests/runtests.py`
7766

78-
## FORMATS
67+
## Formats
7968

8069
*Karta* provides a basic working interface to several of common file formats.
8170
Currently implemented are:
@@ -95,10 +84,10 @@ implement `__geo_interface__` (e.g.
9584
[shapely](https://github.com/Toblerity/Shapely),
9685
[fastkml](https://fastkml.readthedocs.org/en/latest/)).
9786

98-
## INSTALLATION
87+
## Installation
9988

100-
The easiest way to install in production is to use `pip`. Installation requires
101-
a version of `setuptools>=17.0`:
89+
The easiest way to install in production is via `pip`. Installation requires a
90+
recent version of `setuptools`:
10291

10392
pip install -U setuptools
10493

@@ -118,16 +107,17 @@ Then, clone the repository and install:
118107
pip install -r karta/requirements.txt
119108
pip install karta/
120109

121-
## DEPENDENCIES
110+
## Dependencies
122111

123-
- Python 2.7 or Python 3.4+
124-
- numpy
125-
- gdal
126-
- pyproj
127-
- blosc
112+
- numpy >= >1.7
113+
- gdal >= 1.10
114+
- pyproj >= 1.9
115+
- blosc >= 1.2
128116
- C99-compliant compiler
129117

130-
## LICENSE
118+
*Karta* supports Python 2.7 and Python 3.4+.
119+
120+
## License
131121

132122
This software is provided under the MIT license.
133123

doc/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
# The short X.Y version.
5454
version = '0.7'
5555
# The full version, including alpha/beta/rc tags.
56-
release = '0.7b2'
56+
release = '0.7'
5757

5858
# The language for content autogenerated by Sphinx. Refer to documentation
5959
# for a list of supported languages.

karta/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "0.7b2"
1+
__version__ = "0.7"

setup.py

Lines changed: 95 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -74,17 +74,15 @@ def finalize_options(self):
7474
url = "http://www.fortyninemaps.com/karta.html",
7575
description = "Geospatial analysis in Python",
7676
long_description = """*Karta* is a package for spatial analysis in Python. It streamlines data
77-
processing by providing classes for coordinate-system aware geographical vector
78-
and raster data.
77+
processing by providing efficient generic geographical types for vector
78+
and raster sources as well as a selection of analysis functions.
7979
80-
Create vector geometries:
80+
For example, read or create vector geometries:
8181
8282
.. code:: python
8383
8484
point = Point((-130.0, 52.0), crs=LonLatWGS84)
85-
8685
line = read_geojson("linedata.json")
87-
8886
polygon = Polygon([(-515005.78, -1301130.53),
8987
(-579174.89, -1282271.94),
9088
(-542977.83, -1221147.82),
@@ -99,50 +97,116 @@ def finalize_options(self):
9997
10098
point2 = Point((-25.0, 48.0), crs=LonLatWGS84)
10199
point.distance(point2) # Distance in geographical units
102-
103100
line.intersects(polygon) # True or False
104-
105101
ch = polygon.convex_hull() # Returns a new polygon
106102
ch.to_shapefile("poly.shp")
107103
108-
Work with raster data:
104+
Load and manipulate raster data:
109105
110106
.. code:: python
111107
112108
grid = read_gtiff("landsat_scene.tif") # Leverages GDAL
113-
114109
grid.profile(line) # Collect data along a line
115-
116110
grid.resample(500.0, 500.0) # Return a grid resampled at a new resolution
117111
118-
*Karta* works with Python 2 and 3. Suggestions, bug reports, test cases, and
119-
pull requests are welcome.
120-
121-
DOCUMENTATION
112+
Documentation
122113
-------------
123114
124-
See the `webpage <http://www.fortyninemaps.com/karta.html>`__ and the `manual
125-
<http://www.fortyninemaps.com/kartadocs/karta-manual.html>`__.
115+
See the `online
116+
manual <http://www.fortyninemaps.com/kartadocs/introduction.html>`__,
117+
the
118+
`tutorial <http://www.fortyninemaps.com/kartadocs/_static/tutorial.html>`__,
119+
or read the `API
120+
documentation <http://www.fortyninemaps.com/kartadocs/reference.html>`__.
121+
122+
The manual can be built offline using
123+
`Sphinx <http://sphinx-doc.org/>`__. Building the documentation requires
124+
`numpydoc <https://github.com/numpy/numpydoc>`__.
125+
126+
Package Overview
127+
----------------
128+
129+
- **karta.crs**: framework for coordinate reference systems and
130+
geodetic calculations
131+
132+
- **karta.vector.geometry**: geometry classes ``Point``,
133+
``Multipoint``, ``Line``, and ``Polygon`` with associated methods
134+
such as length, area, intersections, membership testing, convex
135+
hulls, and affine transformations
136+
137+
- **karta.raster.grid**: ``Grid`` classes including ``RegularGrid``
138+
class (supporting CRS-aware clipping, sampling, profiling along
139+
vector tracks), and experimental ``WarpedGrid``
140+
141+
- **tests**: unit tests, to be run with ``python tests/runtests.py``
142+
143+
Formats
144+
-------
145+
146+
*Karta* provides a basic working interface to several of common file
147+
formats. Currently implemented are:
148+
149+
- vector
150+
151+
- GeoJSON (r,w)
152+
- ESRI Shapefiles (via GDAL) (r,w)
153+
- GPS eXchange (GPX) (r,w)
154+
155+
- raster
156+
157+
- GeoTiff (via GDAL) (r,w)
158+
- ESRI ASCII Grid (r,w)
159+
160+
*Karta* implements the Python ```__geo_interface__``
161+
attribute <https://gist.github.com/sgillies/2217756>`__ for vector
162+
geometries. This permits data to be exchanged between *Karta* and
163+
external modules that also implement ``__geo_interface__`` (e.g.
164+
`shapely <https://github.com/Toblerity/Shapely>`__,
165+
`fastkml <https://fastkml.readthedocs.org/en/latest/>`__).
166+
167+
Installation
168+
------------
169+
170+
The easiest way to install in production is via ``pip``. Installation
171+
requires a recent version of ``setuptools``:
172+
173+
::
174+
175+
pip install -U setuptools
176+
177+
Then, to install the latest release from PyPI:
178+
179+
::
180+
181+
pip install karta
182+
183+
Building from source
184+
~~~~~~~~~~~~~~~~~~~~
185+
186+
Building from source requires Cython:
187+
188+
::
189+
190+
pip install Cython
191+
192+
Then, clone the repository and install:
193+
194+
::
126195
127-
The manual can also be built offline using Sphinx by running ``make`` from the
128-
``doc/`` subdirectory. The documentation is built from source code docstrings
129-
and the example IPython notebooks, which are also reproduced in the `Wiki
130-
<https://github.com/fortyninemaps/karta/wiki/Tutorial>`__. Building the
131-
documentation requires `Sphinx <http://sphinx-doc.org/>`__, `alabaster
132-
<https://github.com/bitprophet/alabaster>`__ and `numpydoc
133-
<https://github.com/numpy/numpydoc>`__.
196+
git clone https://github.com/fortyninemaps/karta.git karta
197+
pip install -r karta/requirements.txt
198+
pip install karta/
134199
135-
DEPENDENCIES
200+
Dependencies
136201
------------
137202
138-
- numpy
139-
- gdal
140-
- pyproj
141-
- blosc
142-
- C99-compliant compiler
203+
- numpy >= >1.7
204+
- gdal >= 1.10
205+
- pyproj >= 1.9
206+
- blosc >= 1.2
207+
- C99-compliant compiler
143208
144-
When installing from PyPI, C source code is provided. When building from
145-
sources, Cython is required.
209+
*Karta* supports Python 2.7 and Python 3.4+.
146210
""",
147211
classifiers = ["Programming Language :: Python :: 2",
148212
"Programming Language :: Python :: 2.7",

0 commit comments

Comments
 (0)