pycoast 1.6.1__tar.gz → 1.7.0__tar.gz

pycoast-1.7.0/AUTHORS.md

@@ -0,0 +1,20 @@
+# Project Contributors
+
+The following people have made contributions to this project:
+
+<!--- Use your GitHub account or any other personal reference URL --->
+<!--- See https://gist.github.com/djhoese/52220272ec73b12eb8f4a29709be110d for auto-generating parts of this list --->
+
+- Stefano Cerino
+- [Andrew Brooks (howff)](https://github.com/howff)
+- [Adam Dybbroe (adybbroe)](https://github.com/adybbroe)
+- [David Hoese (djhoese)](https://github.com/djhoese)
+- [Katja Hungershofer (khunger)](https://github.com/khunger)
+- [Mikhail Itkin (mitkin)](https://github.com/mitkin)
+- [Panu Lahtinen (pnuu)](https://github.com/pnuu)
+- [Ernst Lobsiger (lobsiger)](https://github.com/lobsiger)
+- [Esben S. Nielsen (storpipfugl)](https://github.com/storpipfugl)
+- [Martin Raspaud (mraspaud)](https://github.com/mraspaud)
+- [Hrobjartur Thorsteinsson (thorsteinssonh)](https://github.com/thorsteinssonh)
+- [Antonio Valentino (avalentino)](https://github.com/avalentino)
+- [Yufei Zhu (yufeizhu600)](https://github.com/yufeizhu600)

{pycoast-1.6.1 → pycoast-1.7.0}/MANIFEST.in

@@ -1,7 +1,7 @@
 include docs/Makefile
 recursive-include docs/source *
 include pycoast/tests/*.png
-include pycoast/tests/*.ttf
+recursive-include pycoast/tests/ *
 include LICENSE.txt
 include MANIFEST.in
 

pycoast-1.7.0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.1
+Name: pycoast
+Version: 1.7.0
+Summary: Writing of coastlines, borders and rivers to images in Python
+Home-page: UNKNOWN
+Author: Esben S. Nielsen
+Author-email: esn@dmi.dk
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >3.9
+Provides-Extra: docs
+Provides-Extra: tests
+License-File: LICENSE.txt
+License-File: AUTHORS.md
+
+PyCoast
+=======
+
+.. image:: https://github.com/pytroll/pycoast/workflows/CI/badge.svg?branch=main
+    :target: https://github.com/pytroll/pycoast/actions?query=workflow%3A%22CI%22
+
+.. image:: https://coveralls.io/repos/github/pytroll/pycoast/badge.svg?branch=main
+    :target: https://coveralls.io/github/pytroll/pycoast?branch=main
+
+.. image:: https://img.shields.io/pypi/v/pycoast.svg
+        :target: https://pypi.python.org/pypi/pycoast
+
+.. image:: https://results.pre-commit.ci/badge/github/pytroll/pycoast/main.svg
+   :target: https://results.pre-commit.ci/latest/github/pytroll/pycoast/main
+   :alt: pre-commit.ci status
+
+Python package for adding coastlines, borders, rivers, lakes, cities, and other
+overlays to raster images.
+
+Installation
+------------
+
+PyCoast can be installed from PyPI using pip::
+
+    pip install pycoast
+
+Or with conda using the conda-forge channel::
+
+    conda install -c conda-forge pycoast
+
+Example
+-------
+
+::
+
+    >>> from PIL import Image
+    >>> from pycoast import ContourWriterAGG
+    >>> img = Image.open('BMNG_clouds_201109181715_areaT2.png')
+    >>> proj4_string = '+proj=stere +lon_0=8.00 +lat_0=50.00 +lat_ts=50.00 +ellps=WGS84'
+    >>> area_extent = (-3363403.31,-2291879.85,2630596.69,2203620.1)
+    >>> area_def = (proj4_string, area_extent)
+    >>> cw = ContourWriterAGG('/home/esn/data/gshhs')
+    >>> cw.add_coastlines(img, area_def, resolution='l', level=4)
+    >>> cw.add_rivers(img, area_def, level=5, outline='blue')
+    >>> cw.add_borders(img, area_def, outline=(255, 0, 0))
+    >>> img.show()
+
+

{pycoast-1.6.1 → pycoast-1.7.0}/docs/Makefile

@@ -35,6 +35,7 @@ help:
 
 clean:
 	-rm -rf $(BUILDDIR)/*
+	-rm -rf source/api/*.rst
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

{pycoast-1.6.1 → pycoast-1.7.0}/docs/source/installation.rst

@@ -34,7 +34,7 @@ rivers, and lakes, shapefiles from the
 installed. Download the zipped GSHHS and WDBII shapefiles. At the time of
 writing the current zip file can be found at:
 
-http://www.soest.hawaii.edu/pwessel/gshhg/gshhg-shp-2.3.7.zip
+https://www.soest.hawaii.edu/pwessel/gshhg/gshhg-shp-2.3.7.zip
 
 Unzip the files to a data directory (hereafter *DB_DATA_ROOT*).
 The absolute path/name of this directory is called *db_root_path*

{pycoast-1.6.1 → pycoast-1.7.0}/pycoast/__init__.py

@@ -26,5 +26,6 @@ class ContourWriter(ContourWriterPIL):
         warnings.warn(
             "'ContourWriter' has been deprecated please use " "'ContourWriterPIL' or 'ContourWriterAGG' instead",
             DeprecationWarning,
+            stacklevel=2,
         )
         super(ContourWriter, self).__init__(*args, **kwargs)

pycoast-1.7.0/pycoast/conftest.py

@@ -0,0 +1,14 @@
+"""The conftest file."""
+
+from pytest import hookimpl
+
+
+@hookimpl(tryfirst=True, hookwrapper=True)
+def pytest_runtest_makereport(item, call):
+    """Add test status in the report for fixtures to use."""
+    # execute all other hooks to obtain the report object
+    outcome = yield
+    rep = outcome.get_result()
+    # store test results for each phase of a call, which can
+    # be "setup", "call", "teardown"
+    setattr(item, "rep_" + rep.when, rep)

{pycoast-1.6.1 → pycoast-1.7.0}/pycoast/cw_agg.py

@@ -91,7 +91,11 @@ class ContourWriterAGG(ContourWriterBase):
     ):
         """Add a text box at position (x,y)."""
         if box_outline is not None:
-            text_size = draw.textsize(text, font)
+            if hasattr(draw, "textsize"):
+                text_size = draw.textsize(text, font)
+            else:
+                left, top, right, bottom = draw.textbbox(text_position, text, font)
+                text_size = right - left, top - bottom
             margin = 2
             xUL = text_position[0] - margin
             yUL = text_position[1]

{pycoast-1.6.1 → pycoast-1.7.0}/pycoast/cw_base.py

@@ -29,9 +29,9 @@ import os
 from typing import Generator
 
 import numpy as np
-import pyproj
 import shapefile
 from PIL import Image
+from pyproj import CRS, Proj
 
 try:
     from pyresample import AreaDefinition
@@ -45,16 +45,11 @@ def get_resolution_from_area(area_def):
     """Get the best resolution for an area definition."""
     x_size = area_def.width
     y_size = area_def.height
-    prj = Proj(area_def.crs if hasattr(area_def, "crs") else area_def.proj_str)
-    if prj.is_latlong():
-        x_ll, y_ll = prj(area_def.area_extent[0], area_def.area_extent[1])
-        x_ur, y_ur = prj(area_def.area_extent[2], area_def.area_extent[3])
-        x_resolution = (x_ur - x_ll) / x_size
-        y_resolution = (y_ur - y_ll) / y_size
-    else:
-        x_resolution = (area_def.area_extent[2] - area_def.area_extent[0]) / x_size
-        y_resolution = (area_def.area_extent[3] - area_def.area_extent[1]) / y_size
+    x_resolution = abs(area_def.area_extent[2] - area_def.area_extent[0]) / x_size
+    y_resolution = abs(area_def.area_extent[3] - area_def.area_extent[1]) / y_size
     res = min(x_resolution, y_resolution)
+    if "degree" in area_def.crs.axis_info[0].unit_name:
+        res = _estimate_metered_resolution_from_degrees(area_def.crs, res)
 
     if res > 25000:
         return "c"
@@ -68,6 +63,12 @@ def get_resolution_from_area(area_def):
         return "f"
 
 
+def _estimate_metered_resolution_from_degrees(crs: CRS, resolution_degrees: float) -> float:
+    major_radius = crs.datum.ellipsoid.semi_major_metre
+    # estimate by taking the arc length using the radius
+    return major_radius * math.radians(resolution_degrees)
+
+
 class _CoordConverter:
     """Convert coordinates from one space to in-bound image pixel column and row.
 
@@ -91,7 +92,8 @@ class _CoordConverter:
             raise ValueError(f"'coord_ref' must be one of {pretty_coord_refs}.")
         self._convert_method = convert_methods[coord_ref]
 
-    def _check_area_def(self, area_def):
+    @staticmethod
+    def _check_area_def(area_def):
         if AreaDefinition is None:
             raise ImportError(
                 "Missing required 'pyresample' module, please "
@@ -130,16 +132,6 @@ def hash_dict(dict_to_hash: dict) -> str:
     return dhash.hexdigest()
 
 
-class Proj(pyproj.Proj):
-    """Wrapper around pyproj to add in 'is_latlong'."""
-
-    def is_latlong(self):
-        if hasattr(self, "crs"):
-            return self.crs.is_geographic
-        # pyproj<2.0
-        return super(Proj, self).is_latlong()
-
-
 class ContourWriterBase(object):
     """Base class for contourwriters. Do not instantiate.
 
@@ -167,7 +159,16 @@ class ContourWriterBase(object):
 
     def _draw_text(self, draw, position, txt, font, align="cc", **kwargs):
         """Draw text with agg module."""
-        txt_width, txt_height = draw.textsize(txt, font)
+        if hasattr(draw, "textsize"):
+            txt_width, txt_height = draw.textsize(txt, font)
+        else:
+            left, top, right, bottom = draw.textbbox(position, txt, font)
+            # bbox is based on "left ascender" anchor for horizontal text
+            # but does not include the ascender to top distance.
+            # In order to include that additional distance we take height from
+            # anchor (`position`) to the bottom of the text. See:
+            # https://pillow.readthedocs.io/en/stable/handbook/text-anchors.html#text-anchors
+            txt_width, txt_height = right - left, bottom - position[1]
         x_pos, y_pos = position
         ax, ay = align.lower()
         if ax == "r":
@@ -178,7 +179,7 @@ class ContourWriterBase(object):
         if ay == "b":
             y_pos = y_pos - txt_height
         elif ay == "c":
-            y_pos = y_pos - txt_width / 2
+            y_pos = y_pos - txt_height / 2
 
         self._engine_text_draw(draw, x_pos, y_pos, txt, font, **kwargs)
 
@@ -506,10 +507,15 @@ class ContourWriterBase(object):
         the same provided AreaDefinition and parameters. Cached results are
         identified by hashing the AreaDefinition and the overlays dictionary.
 
+        Note that if ``background`` is provided and caching is not used, the
+        result will be the final result of applying the overlays onto the
+        background. This is due to an optimization step avoiding creating a
+        separate overlay image in memory when it isn't needed.
+
         .. warning::
 
             Font objects are ignored in parameter hashing as they can't be easily hashed.
-            Therefore font changes will not trigger a new rendering for the cache.
+            Therefore, font changes will not trigger a new rendering for the cache.
 
         :Parameters:
             overlays : dict
@@ -1053,16 +1059,10 @@ def _get_bounding_box_lonlat_sides(area_extent, x_size, y_size, prj):
     x_range = np.linspace(x_ll, x_ur, num=x_size)
     y_range = np.linspace(y_ll, y_ur, num=y_size)
 
-    if prj.is_latlong():
-        lons_s1, lats_s1 = x_ll * np.ones(y_range.size), y_range
-        lons_s2, lats_s2 = x_range, y_ur * np.ones(x_range.size)
-        lons_s3, lats_s3 = x_ur * np.ones(y_range.size), y_range
-        lons_s4, lats_s4 = x_range, y_ll * np.ones(x_range.size)
-    else:
-        lons_s1, lats_s1 = prj(np.ones(y_range.size) * x_ll, y_range, inverse=True)
-        lons_s2, lats_s2 = prj(x_range, np.ones(x_range.size) * y_ur, inverse=True)
-        lons_s3, lats_s3 = prj(np.ones(y_range.size) * x_ur, y_range, inverse=True)
-        lons_s4, lats_s4 = prj(x_range, np.ones(x_range.size) * y_ll, inverse=True)
+    lons_s1, lats_s1 = prj(np.ones(y_range.size) * x_ll, y_range, inverse=True)
+    lons_s2, lats_s2 = prj(x_range, np.ones(x_range.size) * y_ur, inverse=True)
+    lons_s3, lats_s3 = prj(np.ones(y_range.size) * x_ur, y_range, inverse=True)
+    lons_s4, lats_s4 = prj(x_range, np.ones(x_range.size) * y_ll, inverse=True)
     return (lons_s1, lons_s2, lons_s3, lons_s4), (lats_s1, lats_s2, lats_s3, lats_s4)
 
 
@@ -1087,12 +1087,7 @@ def _get_pixel_index(shape, area_extent, x_size, y_size, prj, x_offset=0, y_offs
     shape_data = np.array(shape.points if hasattr(shape, "points") else shape)
     lons = shape_data[:, 0]
     lats = shape_data[:, 1]
-
-    if prj.is_latlong():
-        x_ll, y_ll = prj(area_extent[0], area_extent[1])
-        x_ur, y_ur = prj(area_extent[2], area_extent[3])
-    else:
-        x_ll, y_ll, x_ur, y_ur = area_extent
+    x_ll, y_ll, x_ur, y_ur = area_extent
 
     x, y = prj(lons, lats)
 
@@ -1199,7 +1194,7 @@ class _OverlaysFromDict:
                 foreground = Image.open(cache_file)
                 logger.info("Using image in cache %s", cache_file)
                 if background is not None:
-                    background.paste(foreground, mask=foreground.split()[-1])
+                    _apply_cached_foreground_on_background(background, foreground)
                 return foreground
             logger.info("Regenerating cache file.")
         except OSError:
@@ -1212,7 +1207,7 @@ class _OverlaysFromDict:
         except IOError as e:
             logger.error("Can't save cache: %s", str(e))
         if self._background is not None:
-            self._background.paste(self._foreground, mask=self._foreground.split()[-1])
+            _apply_cached_foreground_on_background(self._background, self._foreground)
 
     def _generate_cache_filename(self, cache_prefix, area_def, overlays_dict):
         area_hash = hash(area_def)
@@ -1443,6 +1438,18 @@ class _OverlaysFromDict:
         )
 
 
+def _apply_cached_foreground_on_background(background, foreground):
+    premult_foreground = foreground.convert("RGBa")
+    if background.mode == "RGBA":
+        # Cached foreground and background are both RGBA, not extra conversions needed
+        background.paste(premult_foreground, mask=premult_foreground)
+        return
+    background_rgba = background.convert("RGBA")
+    background_rgba.paste(premult_foreground, mask=premult_foreground)
+    # overwrite background image in place
+    background.paste(background_rgba)
+
+
 class _GridDrawer:
     """Helper for drawing graticule/grid lines."""
 

pycoast-1.7.0/pycoast/tests/coasts_and_grid.ini

@@ -0,0 +1,13 @@
+[coasts]
+level = 4
+resolution = l
+outline = white
+
+[grid]
+write_text = False
+lon_major = 10.0
+lat_major = 10.0
+lon_minor = 2.0
+lat_minor = 2.0
+minor_outline = blue
+outline = blue

pycoast-1.7.0/pycoast/tests/coasts_and_grid_agg.ini

@@ -0,0 +1,17 @@
+[coasts]
+level = 4
+resolution = l
+outline = white
+
+[grid]
+write_text = True
+lon_major = 10.0
+lat_major = 10.0
+lon_minor = 2.0
+lat_minor = 2.0
+minor_outline = blue
+outline = blue
+lon_placement = tblr
+lat_placement = ''
+font = 'test_data/DejaVuSerif.ttf'
+font_size = 10

pycoast-1.7.0/pycoast/tests/nh_cities_agg.ini

@@ -0,0 +1,26 @@
+[coasts]
+level = 4
+resolution = l
+outline = black
+
+[borders]
+level = 1
+outline = black
+width = 3
+resolution = c
+
+[cities]
+# Backward compatibility: Allows for *ONE* type of cities
+cities_list = Zurich, Oslo, Reykjavik, Fairbanks, Toronto
+font = test_data/DejaVuSerif.ttf
+font_size = 20
+symbol = square
+ptsize = 16
+outline = black
+width = 1
+fill = blue
+fill_opacity = 128
+box_outline = blue
+box_linewidth = 0.5
+box_fill = yellow
+box_opacity = 200

pycoast-1.7.0/pycoast/tests/nh_cities_pil.ini

@@ -0,0 +1,20 @@
+[coasts]
+level = 4
+resolution = l
+outline = black
+
+[borders]
+level = 1
+outline = black
+resolution = c
+
+[cities]
+# Backward compatibility: Allows for *ONE* type of cities
+cities_list = Zurich, Oslo, Reykjavik, Fairbanks, Toronto
+font = test_data/DejaVuSerif.ttf
+font_size = 20
+symbol = square
+ptsize = 16
+outline = black
+fill = blue
+box_outline = blue

pycoast-1.7.0/pycoast/tests/nh_one_shapefile.ini

@@ -0,0 +1,11 @@
+[coasts]
+level = 4
+resolution = l
+outline = yellow
+width = 1.5
+
+[shapefiles]
+# For completeness: Allows for only *ONE* shapefile
+filename = 'test_data/shapes/Metareas.shp'
+outline = cyan
+width = 3.5

pycoast-1.7.0/pycoast/tests/nh_points_agg.ini

@@ -0,0 +1,24 @@
+[coasts]
+level = 4
+resolution = l
+outline = black
+
+[borders]
+level = 1
+outline = black
+width = 3
+resolution = c
+
+[points]
+points_list = ((2.3522, 48.8566), 'Paris'), ((0.1278, 51.5074), 'London')
+font = 'test_data/DejaVuSerif.ttf'
+symbol = circle
+ptsize = 16
+outline = black
+width = 3
+fill = red
+fill_opacity = 128
+box_outline = blue
+box_linewidth = 0.5
+box_fill = yellow
+box_opacity = 200

pycoast-1.7.0/pycoast/tests/nh_points_pil.ini

@@ -0,0 +1,19 @@
+[coasts]
+level = 4
+resolution = l
+outline = black
+
+[borders]
+level = 1
+outline = black
+width = 3
+resolution = c
+
+[points]
+points_list = ((13.4050, 52.5200), 'Berlin'), ((12.4964, 41.9028), 'Rome')
+font = 'test_data/DejaVuSerif.ttf'
+symbol = square
+ptsize = 6
+outline = red
+fill = yellow
+box_outline = black

pycoast-1.7.0/pycoast/tests/test_data/gshhs/CITIES/cities.txt

@@ -0,0 +1,20 @@
+X	Bad Schwalbach	Bad Schwalbach	X	50.14196	8.06964
+X	Belp	Belp	X	46.89129	7.49825
+X	Berlin	Berlin	X	52.52437	13.41053
+X	Dublin	Dublin	X	53.33306	-6.24889
+X	Edinburgh	Edinburgh	X	55.95206	-3.19648
+X	Fairbanks	Fairbanks	X	64.83778	-147.71639
+X	Freiburg	Freiburg	X	47.9959	7.85222
+X	Hilversum	Hilversum	X	52.22333	5.17639
+X	Huesca	Huesca	X	42.13615	-0.4087
+X	London	London	X	42.98339	-81.23304
+X	London	London	X	51.50853	-0.12574
+X	Madrid	Madrid	X	40.4165	-3.70256
+X	Marseille	Marseille	X	43.29695	5.38107
+X	Montélimar	Montelimar	X	44.55468	4.75469
+X	Oslo	Oslo	X	59.91273	10.74609
+X	Paris	Paris	X	48.85341	2.3488
+X	Reykjavík	Reykjavik	X	64.13548	-21.89541
+X	Rome	Rome	X	41.89193	12.51133
+X	Toronto	Toronto	X	43.70011	-79.4163
+X	Zürich	Zurich	X	47.36667	8.55

pycoast-1.7.0/pycoast/tests/test_data/gshhs/GSHHS_shp/l/GSHHS_l_L1.prj

@@ -0,0 +1 @@
+GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137,298.257223563]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]]

pycoast-1.7.0/pycoast/tests/test_data/gshhs/GSHHS_shp/l/GSHHS_l_L2.prj

@@ -0,0 +1 @@
+GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137,298.257223563]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]]

pycoast-1.7.0/pycoast/tests/test_data/gshhs/GSHHS_shp/l/GSHHS_l_L3.prj

@@ -0,0 +1 @@
+GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137,298.257223563]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]]

pycoast-1.7.0/pycoast/tests/test_data/gshhs/GSHHS_shp/l/GSHHS_l_L4.prj

@@ -0,0 +1 @@
+GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137,298.257223563]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]]

pycoast-1.7.0/pycoast/tests/test_data/gshhs/WDBII_shp/c/WDBII_border_c_L1.prj

@@ -0,0 +1 @@
+GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137,298.257223563]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]]

pycoast-1.7.0/pycoast/tests/test_data/gshhs/WDBII_shp/c/WDBII_border_c_L2.prj

@@ -0,0 +1 @@
+GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137,298.257223563]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]]

pycoast-1.7.0/pycoast/tests/test_data/gshhs/WDBII_shp/c/WDBII_border_c_L3.prj

@@ -0,0 +1 @@
+GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137,298.257223563]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]]

pycoast-1.7.0/pycoast/tests/test_data/gshhs/WDBII_shp/c/WDBII_river_c_L01.prj

@@ -0,0 +1 @@
+GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137,298.257223563]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]]

pycoast-1.7.0/pycoast/tests/test_data/gshhs/WDBII_shp/c/WDBII_river_c_L02.prj

@@ -0,0 +1 @@
+GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137,298.257223563]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]]

pycoast-1.7.0/pycoast/tests/test_data/gshhs/WDBII_shp/c/WDBII_river_c_L03.prj

@@ -0,0 +1 @@
+GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137,298.257223563]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]]