Scalebar

docs/make_projection.py

@@ -35,7 +35,7 @@ def plate_carree_plot():
     for i in range(0, nplots):
         central_longitude = 0 if i == 0 else 180
         ax = fig.add_subplot(
-            nplots, 1, i+1,
+            nplots, 1, i + 1,
             projection=ccrs.PlateCarree(central_longitude=central_longitude))
         ax.coastlines(resolution='110m')
         ax.gridlines()
@@ -69,8 +69,8 @@ def utm_plot():
     fig = plt.figure(figsize=(10, 3))
 
     for i in range(0, nplots):
-        ax = fig.add_subplot(1, nplots, i+1,
-                             projection=ccrs.UTM(zone=i+1,
+        ax = fig.add_subplot(1, nplots, i + 1,
+                             projection=ccrs.UTM(zone=i + 1,
                                                  southern_hemisphere=True))
         ax.coastlines(resolution='110m')
         ax.gridlines()

docs/source/conf.py

@@ -19,7 +19,6 @@
 from datetime import datetime
 import os
 import sys
-
 import cartopy
 from distutils.version import LooseVersion
 import matplotlib
@@ -31,7 +30,7 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
 
-# -- General configuration -----------------------------------------------------
+# -- General configuration -----------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
 needs_sphinx = '1.6'
@@ -130,7 +129,8 @@
 # directories to ignore when looking for source files.
 exclude_patterns = []
 
-# The reST default role (used for this markup: `text`) to use for all documents.
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
 default_role = 'py:obj'
 
 # Handle subclasses of Matplotlib using an :rc: context in documentation
@@ -156,7 +156,7 @@
 # modindex_common_prefix = []
 
 
-# -- Options for HTML output ---------------------------------------------------
+# -- Options for HTML output ---------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
@@ -239,26 +239,26 @@
 htmlhelp_basename = 'cartopydoc'
 
 
-# -- Options for LaTeX output --------------------------------------------------
+# -- Options for LaTeX output --------------------------------------------
 
 latex_elements = {
-                    # The paper size ('letterpaper' or 'a4paper').
-                    # 'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
 
-                    # The font size ('10pt', '11pt' or '12pt').
-                    # 'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
 
-                    # Additional stuff for the LaTeX preamble.
-                    # 'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'cartopy.tex', 'Cartopy Introduction',
-   'Philip Elson, Richard Hattersley', 'manual', False),
-  ('introductory_examples/index', 'cartopy_examples.tex', 'Cartopy examples',
-   'Philip Elson, Richard Hattersley', 'manual', True)
+    ('index', 'cartopy.tex', 'Cartopy Introduction',
+     'Philip Elson, Richard Hattersley', 'manual', False),
+    ('introductory_examples/index', 'cartopy_examples.tex', 'Cartopy examples',
+        'Philip Elson, Richard Hattersley', 'manual', True)
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -282,7 +282,7 @@
 # latex_domain_indices = True
 
 
-# -- Options for manual page output --------------------------------------------
+# -- Options for manual page output --------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
@@ -295,16 +295,16 @@
 # man_show_urls = False
 
 
-# -- Options for Texinfo output ------------------------------------------------
+# -- Options for Texinfo output ------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'cartopy', 'cartopy Documentation',
-   'Philip Elson, Richard Hattersley', 'cartopy',
-   'One line description of project.',
-   'Miscellaneous'),
+    ('index', 'cartopy', 'cartopy Documentation',
+     'Philip Elson, Richard Hattersley', 'cartopy',
+     'One line description of project.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -317,7 +317,7 @@
 # texinfo_show_urls = 'footnote'
 
 
-# -- Options for Epub output ---------------------------------------------------
+# -- Options for Epub output ---------------------------------------------
 
 # Bibliographic Dublin Core info.
 epub_title = 'cartopy'
@@ -371,13 +371,12 @@
 
 ############ extlinks extension ############
 extlinks = {'issues': ('https://github.com/SciTools/cartopy/labels/%s',
-                      'issues labeled with '),
+                       'issues labeled with '),
             'issue': ('https://github.com/SciTools/cartopy/issues/%s',
                       'Issue #'),
             'pull': ('https://github.com/SciTools/cartopy/pull/%s', 'PR #'),
             }
 
-
 ############ plot directive ##############
 
 plot_html_show_formats = False

docs/source/contributors.rst

@@ -40,6 +40,7 @@ the package wouldn't be as rich or diverse as it is today:
  * Greg Lucas
  * Sadie Bartholomew
  * Kacper Makuch
+ * Philipe Riskalla Leal
  * Stephane Raynaud
  * John Krasting
 

examples/gridlines_and_labels/gridliner.py

@@ -1,20 +1,16 @@
 """
 Gridlines and tick labels
 -------------------------
-
 These examples demonstrate how to quickly add longitude
 and latitude gridlines and tick labels on a non-rectangular projection.
-
 As you can see on the first example,
 longitude labels may be drawn on left and right sides,
 and latitude labels may be drawn on bottom and top sides.
 Thanks to the ``dms`` keyword, minutes are used when appropriate
 to display fractions of degree.
-
 In the second example, labels are still drawn at the map edges
 despite its complexity, and some others are also drawn within the map
 boundary.
-
 In the third example, labels are drawn only on the left and bottom sides.
 """
 import cartopy.crs as ccrs

examples/lines_and_polygons/always_circular_stereo.py

@@ -41,7 +41,7 @@ def main():
     # Compute a circle in axes coordinates, which we can use as a boundary
     # for the map. We can pan/zoom as much as we like - the boundary will be
     # permanently circular.
-    theta = np.linspace(0, 2*np.pi, 100)
+    theta = np.linspace(0, 2 * np.pi, 100)
     center, radius = [0.5, 0.5], 0.5
     verts = np.vstack([np.sin(theta), np.cos(theta)]).T
     circle = mpath.Path(verts * radius + center)

examples/miscellanea/un_flag.py

@@ -29,8 +29,8 @@ def olive_path():
 
     """
     olives_verts = np.array(
-        [[0,   2,   6,   9,  30,  55,  79,  94, 104, 117, 134, 157, 177,
-          188, 199, 207, 191, 167, 149, 129, 109,  87,  53,  22,   0, 663,
+        [[0, 2, 6, 9, 30, 55, 79, 94, 104, 117, 134, 157, 177,
+          188, 199, 207, 191, 167, 149, 129, 109, 87, 53, 22, 0, 663,
           245, 223, 187, 158, 154, 150, 146, 149, 154, 158, 181, 184, 197,
           181, 167, 153, 142, 129, 116, 119, 123, 127, 151, 178, 203, 220,
           237, 245, 663, 280, 267, 232, 209, 205, 201, 196, 196, 201, 207,
@@ -47,14 +47,14 @@ def olive_path():
           249, 242, 231, 214, 208, 208, 227, 244, 252, 258, 262, 262, 261,
           262, 264, 265, 252, 663, 185, 197, 206, 215, 223, 233, 242, 237,
           237, 230, 220, 202, 185, 663],
-         [8,   5,   3,   0,  22,  46,  46,  46,  35,  27,  16,  10,  18,
-          22,  28,  38,  27,  26,  33,  41,  52,  52,  52,  30,   8, 595,
-          77,  52,  61,  54,  53,  52,  53,  55,  55,  57,  65,  90, 106,
-          96,  81,  68,  58,  54,  51,  50,  51,  50,  44,  34,  43,  48,
-          61,  77, 595, 135, 104, 102,  83,  79,  76,  74,  74,  79,  84,
-          90, 109, 135, 156, 145, 133, 121, 100,  77,  62,  69,  67,  80,
+         [8, 5, 3, 0, 22, 46, 46, 46, 35, 27, 16, 10, 18,
+          22, 28, 38, 27, 26, 33, 41, 52, 52, 52, 30, 8, 595,
+          77, 52, 61, 54, 53, 52, 53, 55, 55, 57, 65, 90, 106,
+          96, 81, 68, 58, 54, 51, 50, 51, 50, 44, 34, 43, 48,
+          61, 77, 595, 135, 104, 102, 83, 79, 76, 74, 74, 79, 84,
+          90, 109, 135, 156, 145, 133, 121, 100, 77, 62, 69, 67, 80,
           92, 113, 135, 595, 198, 171, 156, 134, 129, 124, 120, 123, 126,
-          129, 138, 149, 161, 175, 188, 202, 177, 144, 116, 110, 105,  99,
+          129, 138, 149, 161, 175, 188, 202, 177, 144, 116, 110, 105, 99,
           108, 116, 126, 136, 147, 162, 173, 186, 198, 595, 249, 255, 261,
           267, 241, 222, 200, 192, 183, 175, 175, 175, 175, 199, 221, 240,
           245, 250, 256, 245, 233, 222, 207, 194, 180, 172, 162, 153, 154,

examples/scalebar/scalebar_usage_examples.py

@@ -0,0 +1,61 @@
+# Copyright Cartopy Contributors
+#
+# This file is part of Cartopy and is released under the LGPL license.
+# See COPYING and COPYING.LESSER in the root of the repository for full
+# licensing details.
+
+import matplotlib.pyplot as plt
+import cartopy.crs as ccrs
+from cartopy.mpl.scalebar import fancy_scalebar
+
+
+def scalebar_invoqued_as_an_independent_object_geoaxes():
+
+    fig, axes = plt.subplots(1, 2,
+                             subplot_kw={'projection':
+                                         ccrs.Mercator()})
+
+    projections = [ccrs.Mercator(), ccrs.PlateCarree()]
+
+    axes = axes.ravel()
+
+    for proj, ax in zip(projections, axes):
+        ax.projection = proj
+        fancy_scalebar(ax,
+                       location=(0.5, 0.2),
+                       length=1000_000,
+                       unit_name='km',
+                       angle=0,
+                       max_stripes=5,
+                       fontsize=8,
+                       dy=0.05)
+
+        ax.gridlines(draw_labels=True)
+        ax.stock_img()
+        ax.coastlines()
+
+
+def scalebar_from_within_geoaxes():
+
+    fig, axes = plt.subplots(1, 2,
+                             subplot_kw={'projection':
+                                         ccrs.Mercator()})
+
+    projections = [ccrs.Mercator(),
+                   ccrs.PlateCarree()]
+
+    axes = axes.ravel()
+
+    for proj, ax in zip(projections, axes):
+        ax.projection = proj
+
+        ax.set_extent([-60, -35, -40, 10])
+        ax.gridlines(draw_labels=True)
+        ax.add_scalebar(location=(0.5, 0.5),
+                        length=250_000,
+                        dy=5,
+                        max_stripes=3)
+        ax.stock_img()
+        ax.coastlines()
+
+    fig.show()

lib/cartopy/crs.py

@@ -640,6 +640,7 @@ class RotatedGeodetic(CRS):
     central_rotated_longitude value.
 
     """
+
     def __init__(self, pole_longitude, pole_latitude,
                  central_rotated_longitude=0.0, globe=None):
         """
@@ -1289,6 +1290,7 @@ class _RectangularProjection(Projection, metaclass=ABCMeta):
     is symmetric about the origin.
 
     """
+
     def __init__(self, proj4_params, half_width, half_height, globe=None):
         self._half_width = half_width
         self._half_height = half_height
@@ -1427,6 +1429,7 @@ class TransverseMercator(Projection):
     A Transverse Mercator projection.
 
     """
+
     def __init__(self, central_longitude=0.0, central_latitude=0.0,
                  false_easting=0.0, false_northing=0.0,
                  scale_factor=1.0, globe=None, approx=None):
@@ -1556,6 +1559,7 @@ class UTM(Projection):
     Universal Transverse Mercator projection.
 
     """
+
     def __init__(self, zone, southern_hemisphere=False, globe=None):
         """
         Parameters
@@ -1590,13 +1594,13 @@ def boundary(self):
     def x_limits(self):
         easting = 5e5
         # allow 50% overflow
-        return (0 - easting/2, 2 * easting + easting/2)
+        return (0 - easting / 2, 2 * easting + easting / 2)
 
     @property
     def y_limits(self):
         northing = 1e7
         # allow 50% overflow
-        return (0 - northing, 2 * northing + northing/2)
+        return (0 - northing, 2 * northing + northing / 2)
 
 
 class EuroPP(UTM):
@@ -1606,6 +1610,7 @@ class EuroPP(UTM):
     Ellipsoid is International 1924, Datum is ED50.
 
     """
+
     def __init__(self):
         globe = Globe(ellipse='intl')
         super().__init__(32, globe=globe)
@@ -2674,6 +2679,7 @@ class Geostationary(_Satellite):
     the satellite.
 
     """
+
     def __init__(self, central_longitude=0.0, satellite_height=35785831,
                  false_easting=0, false_northing=0, globe=None,
                  sweep_axis='y'):

lib/cartopy/feature/__init__.py

@@ -113,6 +113,7 @@ class Scaler:
     """
     General object for handling the scale of the geometries used in a Feature.
     """
+
     def __init__(self, scale):
         self._scale = scale
 
@@ -140,6 +141,7 @@ class AdaptiveScaler(Scaler):
     """
     Automatically select scale of geometries based on extent of plotted axes.
     """
+
     def __init__(self, default_scale, limits):
         """
         Parameters
@@ -198,6 +200,7 @@ class ShapelyFeature(Feature):
     shapely geometries.
 
     """
+
     def __init__(self, geometries, crs, **kwargs):
         """
         Parameters
@@ -227,6 +230,7 @@ class NaturalEarthFeature(Feature):
     See https://www.naturalearthdata.com/
 
     """
+
     def __init__(self, category, name, scale, **kwargs):
         """
         Parameters
@@ -345,6 +349,7 @@ class GSHHSFeature(Feature):
     instantiating multiple GSHHS artists, by reducing repeated file IO.
 
     """
+
     def __init__(self, scale='auto', levels=None, **kwargs):
         super().__init__(cartopy.crs.PlateCarree(), **kwargs)
 
@@ -424,6 +429,7 @@ class WFSFeature(Feature):
     This feature requires additional dependencies. If installed via pip,
     try ``pip install cartopy[ows]``.
     """
+
     def __init__(self, wfs, features, **kwargs):
         """
         Parameters