Skip to content

Commit a8982d2

Browse files
maxdswainmartinfleis
maxdswain
and
martinfleis
authored
Fix inconsistency in import alias (#230)
* Fix inconsistency in import alias * remaining changes --------- Co-authored-by: Martin Fleischmann <[email protected]>
1 parent 224570c commit a8982d2

File tree

7 files changed

+96
-96
lines changed

7 files changed

+96
-96
lines changed

‎contextily/place.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ def plot(self, ax=None, zoom=ZOOM, interpolation=INTERPOLATION, attribution=None
177177
Examples
178178
--------
179179
180-
>>> lvl = ctx.Place('Liverpool')
180+
>>> lvl = cx.Place('Liverpool')
181181
>>> lvl.plot()
182182
183183
"""

‎contextily/plotting.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ def add_basemap(
8282
--------
8383
8484
>>> import geopandas
85-
>>> import contextily as ctx
85+
>>> import contextily as cx
8686
>>> db = geopandas.read_file(ps.examples.get_path('virginia.shp'))
8787
8888
Ensure the data is in Spherical Mercator:
@@ -92,15 +92,15 @@ def add_basemap(
9292
Add a web basemap:
9393
9494
>>> ax = db.plot(alpha=0.5, color='k', figsize=(6, 6))
95-
>>> ctx.add_basemap(ax, source=url)
95+
>>> cx.add_basemap(ax, source=url)
9696
>>> plt.show()
9797
9898
Or download a basemap to a local file and then plot it:
9999
100100
>>> source = 'virginia.tiff'
101-
>>> _ = ctx.bounds2raster(*db.total_bounds, zoom=6, source=source)
101+
>>> _ = cx.bounds2raster(*db.total_bounds, zoom=6, source=source)
102102
>>> ax = db.plot(alpha=0.5, color='k', figsize=(6, 6))
103-
>>> ctx.add_basemap(ax, source=source)
103+
>>> cx.add_basemap(ax, source=source)
104104
>>> plt.show()
105105
106106
"""

‎examples/plot_map.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
"""
1919
import numpy as np
2020
import matplotlib.pyplot as plt
21-
import contextily as ctx
21+
import contextily as cx
2222

23-
loc = ctx.Place("boulder", zoom_adjust=0) # zoom_adjust modifies the auto-zoom
23+
loc = cx.Place("boulder", zoom_adjust=0) # zoom_adjust modifies the auto-zoom
2424

2525
# Print some metadata
2626
for attr in ["w", "s", "e", "n", "place", "zoom", "n_tiles"]:
@@ -30,14 +30,14 @@
3030
im1 = loc.im
3131

3232
fig, axs = plt.subplots(1, 3, figsize=(15, 5))
33-
ctx.plot_map(loc, ax=axs[0])
33+
cx.plot_map(loc, ax=axs[0])
3434

3535
###############################################################################
3636
# The zoom level will be chosen for you by default, though you can specify
3737
# this manually as well:
3838

39-
loc2 = ctx.Place("boulder", zoom=11)
40-
ctx.plot_map(loc2, ax=axs[1])
39+
loc2 = cx.Place("boulder", zoom=11)
40+
cx.plot_map(loc2, ax=axs[1])
4141

4242
###############################################################################
4343
# Downloading tiles from bounds
@@ -46,7 +46,7 @@
4646
# You can also grab tile information directly from a bounding box + zoom level.
4747
# This is demoed below:
4848

49-
im2, bbox = ctx.bounds2img(loc.w, loc.s, loc.e, loc.n, zoom=loc.zoom, ll=True)
50-
ctx.plot_map(im2, bbox, ax=axs[2], title="Boulder, CO")
49+
im2, bbox = cx.bounds2img(loc.w, loc.s, loc.e, loc.n, zoom=loc.zoom, ll=True)
50+
cx.plot_map(im2, bbox, ax=axs[2], title="Boulder, CO")
5151

5252
plt.show()

‎notebooks/providers_deepdive.ipynb

+17-17
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"metadata": {},
1717
"outputs": [],
1818
"source": [
19-
"import contextily as ctx\n",
19+
"import contextily as cx\n",
2020
"import xyzservices.providers as xyz\n",
2121
"\n",
2222
"import matplotlib.pyplot as plt"
@@ -60,7 +60,7 @@
6060
"source": [
6161
"fig, ax = plt.subplots(figsize=(8, 8))\n",
6262
"ax.axis(extent)\n",
63-
"ctx.add_basemap(ax)"
63+
"cx.add_basemap(ax)"
6464
]
6565
},
6666
{
@@ -91,7 +91,7 @@
9191
"source": [
9292
"fig, ax = plt.subplots(figsize=(8, 8))\n",
9393
"ax.axis(extent)\n",
94-
"ctx.add_basemap(ax, source=ctx.providers.CartoDB.Positron)"
94+
"cx.add_basemap(ax, source=cx.providers.CartoDB.Positron)"
9595
]
9696
},
9797
{
@@ -120,14 +120,14 @@
120120
"source": [
121121
"fig, ax = plt.subplots(figsize=(8, 8))\n",
122122
"ax.axis(extent)\n",
123-
"ctx.add_basemap(ax, source=ctx.providers.OpenStreetMap.Mapnik)"
123+
"cx.add_basemap(ax, source=cx.providers.OpenStreetMap.Mapnik)"
124124
]
125125
},
126126
{
127127
"cell_type": "markdown",
128128
"metadata": {},
129129
"source": [
130-
"Passing `source=ctx.providers.OpenStreetMap.Mapnik` is exactly the same as using `xyzservices` directly - `source=xyz.OpenStreetMap.Mapnik`. Under the hood, `contextily.providers` just wraps `xyzservices.providers`."
130+
"Passing `source=cx.providers.OpenStreetMap.Mapnik` is exactly the same as using `xyzservices` directly - `source=xyz.OpenStreetMap.Mapnik`. Under the hood, `contextily.providers` just wraps `xyzservices.providers`."
131131
]
132132
},
133133
{
@@ -149,7 +149,7 @@
149149
"source": [
150150
"fig, ax = plt.subplots(figsize=(8, 8))\n",
151151
"ax.axis(extent)\n",
152-
"ctx.add_basemap(ax, source=xyz.OpenStreetMap.Mapnik)"
152+
"cx.add_basemap(ax, source=xyz.OpenStreetMap.Mapnik)"
153153
]
154154
},
155155
{
@@ -18639,7 +18639,7 @@
1863918639
}
1864018640
],
1864118641
"source": [
18642-
"ctx.providers"
18642+
"cx.providers"
1864318643
]
1864418644
},
1864518645
{
@@ -18997,7 +18997,7 @@
1899718997
}
1899818998
],
1899918999
"source": [
19000-
"ctx.providers.OpenStreetMap"
19000+
"cx.providers.OpenStreetMap"
1900119001
]
1900219002
},
1900319003
{
@@ -19024,7 +19024,7 @@
1902419024
}
1902519025
],
1902619026
"source": [
19027-
"type(ctx.providers.OpenStreetMap.Mapnik)"
19027+
"type(cx.providers.OpenStreetMap.Mapnik)"
1902819028
]
1902919029
},
1903019030
{
@@ -19189,7 +19189,7 @@
1918919189
}
1919019190
],
1919119191
"source": [
19192-
"ctx.providers.OpenStreetMap.Mapnik"
19192+
"cx.providers.OpenStreetMap.Mapnik"
1919319193
]
1919419194
},
1919519195
{
@@ -19373,7 +19373,7 @@
1937319373
}
1937419374
],
1937519375
"source": [
19376-
"ctx.providers.OpenWeatherMap.Clouds"
19376+
"cx.providers.OpenWeatherMap.Clouds"
1937719377
]
1937819378
},
1937919379
{
@@ -19541,7 +19541,7 @@
1954119541
}
1954219542
],
1954319543
"source": [
19544-
"ctx.providers.OpenWeatherMap.Clouds(apiKey=\"my-private-api-key\")"
19544+
"cx.providers.OpenWeatherMap.Clouds(apiKey=\"my-private-api-key\")"
1954519545
]
1954619546
},
1954719547
{
@@ -19551,7 +19551,7 @@
1955119551
"This can then be specified where a `source` is expected. For example:\n",
1955219552
" \n",
1955319553
"```python\n",
19554-
"ctx.add_basemap(ax, source=ctx.providers.OpenWeatherMap.Clouds(apiKey=\"my-private-api-key\"))\n",
19554+
"cx.add_basemap(ax, source=cx.providers.OpenWeatherMap.Clouds(apiKey=\"my-private-api-key\"))\n",
1955519555
"```\n"
1955619556
]
1955719557
},
@@ -19588,8 +19588,8 @@
1958819588
"source": [
1958919589
"fig, ax = plt.subplots(figsize=(8, 8))\n",
1959019590
"ax.axis(extent)\n",
19591-
"# using the url from `ctx.providers.OpenStreetMap.HOT` as example\n",
19592-
"ctx.add_basemap(ax, source='https://a.tile.openstreetmap.fr/hot/{z}/{x}/{y}.png')"
19591+
"# using the url from `cx.providers.OpenStreetMap.HOT` as example\n",
19592+
"cx.add_basemap(ax, source='https://a.tile.openstreetmap.fr/hot/{z}/{x}/{y}.png')"
1959319593
]
1959419594
},
1959519595
{
@@ -19619,7 +19619,7 @@
1961919619
"metadata": {},
1962019620
"outputs": [],
1962119621
"source": [
19622-
"providers = ctx.providers.flatten()"
19622+
"providers = cx.providers.flatten()"
1962319623
]
1962419624
},
1962519625
{
@@ -19696,7 +19696,7 @@
1969619696
"axs = axs.flatten()\n",
1969719697
"for name, ax in zip(selection, axs):\n",
1969819698
" ax.axis(extent)\n",
19699-
" ctx.add_basemap(ax, source=providers[name])\n",
19699+
" cx.add_basemap(ax, source=providers[name])\n",
1970019700
" ax.set_title(name)\n",
1970119701
" ax.set_axis_off()\n",
1970219702
"plt.show()\n",

‎notebooks/working_with_local_files.ipynb

+9-9
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"source": [
1818
"%matplotlib inline\n",
1919
"\n",
20-
"import contextily as ctx\n",
20+
"import contextily as cx\n",
2121
"import geopandas\n",
2222
"import rasterio\n",
2323
"from rasterio.plot import show as rioshow\n",
@@ -90,7 +90,7 @@
9090
],
9191
"source": [
9292
"ax = cliwoc.plot(linewidth=0.01, alpha=0.5, color=\"k\")\n",
93-
"ctx.add_basemap(ax, \n",
93+
"cx.add_basemap(ax, \n",
9494
" crs=cliwoc.crs,\n",
9595
" )"
9696
]
@@ -145,7 +145,7 @@
145145
"metadata": {},
146146
"outputs": [],
147147
"source": [
148-
"img, ext = ctx.bounds2raster(west, \n",
148+
"img, ext = cx.bounds2raster(west, \n",
149149
" south, \n",
150150
" east, \n",
151151
" north, \n",
@@ -227,7 +227,7 @@
227227
}
228228
],
229229
"source": [
230-
"cape_town = ctx.Place(\"Cape Town\", source=ctx.providers.OpenStreetMap.Mapnik)\n",
230+
"cape_town = cx.Place(\"Cape Town\", source=cx.providers.OpenStreetMap.Mapnik)\n",
231231
"cape_town.plot()"
232232
]
233233
},
@@ -244,7 +244,7 @@
244244
"metadata": {},
245245
"outputs": [],
246246
"source": [
247-
"cape_town = ctx.Place(\"Cape Town\", source=ctx.providers.OpenStreetMap.Mapnik, path=\"cape_town.tif\")"
247+
"cape_town = cx.Place(\"Cape Town\", source=cx.providers.OpenStreetMap.Mapnik, path=\"cape_town.tif\")"
248248
]
249249
},
250250
{
@@ -454,7 +454,7 @@
454454
],
455455
"source": [
456456
"ax = cliwoc_cape_town.plot(linewidth=0.05, color=\"k\")\n",
457-
"ctx.add_basemap(ax, \n",
457+
"cx.add_basemap(ax, \n",
458458
" crs=cliwoc_cape_town.crs, \n",
459459
" source=\"cape_town.tif\"\n",
460460
" )"
@@ -487,7 +487,7 @@
487487
],
488488
"source": [
489489
"ax = cliwoc_cape_town.plot(linewidth=0.05, color=\"k\")\n",
490-
"ctx.add_basemap(ax, \n",
490+
"cx.add_basemap(ax, \n",
491491
" crs=cliwoc_cape_town.crs, \n",
492492
" source=\"cape_town.tif\",\n",
493493
" alpha=0.5\n",
@@ -521,7 +521,7 @@
521521
],
522522
"source": [
523523
"ax = cliwoc_cape_town_buffer.plot(linewidth=1, color=\"k\")\n",
524-
"ctx.add_basemap(ax, \n",
524+
"cx.add_basemap(ax, \n",
525525
" crs=cliwoc_cape_town.crs, \n",
526526
" source=\"cape_town.tif\"\n",
527527
" )"
@@ -552,7 +552,7 @@
552552
],
553553
"source": [
554554
"ax = cliwoc_cape_town_buffer.plot(linewidth=1, color=\"k\")\n",
555-
"ctx.add_basemap(ax, \n",
555+
"cx.add_basemap(ax, \n",
556556
" crs=cliwoc_cape_town.crs, \n",
557557
" source=\"cape_town.tif\",\n",
558558
" reset_extent=False\n",

0 commit comments

Comments
 (0)