API for geoplots with GeoMakie.jl and docs

.github/workflows/ci.yml

@@ -9,21 +9,26 @@ on:
     tags: '*'
 jobs:
   test:
-    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    name: Tests, Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         version:
-          - '1' # Leave this line unchanged. '1' will automatically expand to the latest stable 1.x release of Julia.
-          - 'nightly'
-        os:
-          - ubuntu-latest
+          - '1' # Replace this with the minimum Julia version that your package supports. E.g. if your package requires Julia 1.5 or higher, change this to '1.5'.
+        os:  [ubuntu-latest, windows-latest, macos-latest] # adjust according to need, e.g. os: [ubuntu-latest] if testing only on linux
         arch:
           - x64
     steps:
-      - name: Checkout
-        uses: actions/checkout@v2
+      # Cancel ongoing CI test runs if pushing to branch again before the previous tests
+      # have finished
+      - name: Cancel ongoing test runs for previous commits
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ github.token }}
+
+      # Do tests
+      - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
         with:
           version: ${{ matrix.version }}
@@ -38,9 +43,35 @@ jobs:
             ${{ runner.os }}-test-${{ env.cache-name }}-
             ${{ runner.os }}-test-
             ${{ runner.os }}-
-      - run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
-      - run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=@. -e 'using Pkg; Pkg.build(); Pkg.test(coverage=true)'
-      - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v1
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+
+
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      # Cancel ongoing documentation build if pushing to branch again before the previous
+      # build is finished.
+      - name: Cancel ongoing documentation builds for previous commits
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ github.token }}
+
+      # Build docs
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
         with:
-          file: lcov.info
+          version: '1'
+      - name: Instantiate and install dependencies
+        run: |
+          julia --project=docs -e '
+            using Pkg
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()'
+      - name: Generate documentation and deploy
+        env: # needed for pushing to gh-pages branch
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+        run:
+          julia --project=docs docs/make.jl

.gitignore

@@ -7,3 +7,4 @@
 /docs/build/
 /docs/site/
 stuff.jl
+.vscode

Project.toml

@@ -1,7 +1,7 @@
 name = "GeoMakie"
 uuid = "db073c08-6b98-4ee5-b6a4-5efafb3259c6"
-authors = ["Anshul Singhvi"]
-version = "0.2.2"
+authors = ["Makie.jl Contributors"]
+version = "0.3.0"
 
 [deps]
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
@@ -10,6 +10,7 @@ GeoJSON = "61d90e0f-e114-555e-ac52-39dfb47a3ef9"
 GeometryBasics = "5c1252a2-5f33-56bf-86c9-59e7332b4326"
 ImageMagick = "6218d12a-5da1-5696-b52f-db25d2ecc6d1"
 Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
+Proj4 = "9a7e659c-8ee8-5706-894e-f68f43bc57ea"
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 StructArrays = "09ab397b-f2b6-538f-b94a-2f83cf4a842a"
 
@@ -20,15 +21,12 @@ GeoJSON = "0.5"
 GeometryBasics = "0.4.1"
 ImageMagick = "1"
 Makie = "0.15.2"
-Reexport = "0.2, 1.0"
+Reexport = "1"
 StructArrays = "0.4, 0.5, 0.6"
 julia = "1"
 
 [extras]
-CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
-Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
-Proj4 = "9a7e659c-8ee8-5706-894e-f68f43bc57ea"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test", "Downloads", "CairoMakie", "Proj4"]
+test = ["Test"]

README.md

@@ -1,5 +1,5 @@
 # GeoMakie
-## Geographic plotting utilities for <a href = "https://www.github.com/JuliaPlots/Makie.jl"><img src="https://raw.githubusercontent.com/JuliaPlots/Makie.jl/master/assets/logo.png" alt="Makie.jl" height="30" align = "top"></a>
+## Geographic plotting utilities for Makie.jl <a href = "https://www.github.com/JuliaPlots/Makie.jl"><img src="https://raw.githubusercontent.com/JuliaPlots/Makie.jl/master/assets/logo.png" alt="Makie.jl" height="30" align = "top"></a>
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaPlots.github.io/GeoMakie.jl/stable)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaPlots.github.io/GeoMakie.jl/dev)
@@ -12,83 +12,4 @@ This package is **in development** and will **break often**.  You can install it
 ]add GeoMakie
 ```
 
-## Examples
-
-```julia
-using GLMakie
-using GeoMakie
-using GeoMakie.GeoInterface
-using GeoMakie.GeoJSON
-using Downloads
-using Proj4
-
-begin
-    # select a coordinate projection, using a string that PROJ accepts
-    # see e.g. https://proj.org/operations/projections/index.html
-    source = "+proj=longlat +datum=WGS84"
-    dest = "+proj=natearth2"
-    trans = Proj4.Transformation(source, dest, always_xy=true)
-    ptrans = Makie.PointTrans{2}(trans)
-
-    fig = Figure()
-    ax = Axis(fig[1,1], aspect = DataAspect())
-
-    # all input data coordinates are projected using this function
-    ax.scene.transformation.transform_func[] = ptrans
-
-    # draw projected grid lines and set limits accordingly
-    lats = -90:10.0:90
-    lons = -180:10.0:180
-    lons = collect(lons)
-    lons[end] = prevfloat(lons[end])  # avoid PROJ wrapping 180 to -180
-    field = [exp(cosd(l)) + 3(y/90) for l in lons, y in lats]
-    points = map(CartesianIndices(size(field))) do xy
-        x, y = Tuple(xy)
-        Point2f(lons[x], lats[y])
-    end
-    limits = Rect2f(Makie.apply_transform(ptrans, points))
-    limits!(ax, limits)
-    wireframe!(ax, lons, lats, field, color=(:gray, 0.2), transparency=true)
-
-    # add black polygons for land area
-    url = "https://raw.githubusercontent.com/nvkelso/natural-earth-vector/master/geojson/"
-    land = Downloads.download(url * "ne_110m_land.geojson", IOBuffer())
-    land_geo = GeoJSON.read(seekstart(land))
-    poly!(ax, land_geo, color="black")
-
-    # add grey dots for populated places
-    pop = Downloads.download(url * "ne_10m_populated_places_simple.geojson", IOBuffer())
-    pop_geo = GeoJSON.read(seekstart(pop))
-    scatter!(ax, GeoMakie.geo2basic(pop_geo), color="lightgrey", markersize=1.2)
-
-    hidedecorations!(ax)
-    hidespines!(ax)
-    display(fig)
-end
-```
-![image](https://user-images.githubusercontent.com/4471859/123510397-8116ab00-d67b-11eb-8414-cffd18d60f05.png)
-
-These plots can be arbitrarily colored using the `color` keyword, and the full Makie interface is also exposed.
-
-Check the examples in the `test` folder for more recent examples of usage.
-
-## Performance
-
-We use Earcut.jl for added performance when converting polygons to triangular meshes; it decreases time to mesh by an order of magnitude from the Makie implementation.
-
-Since `surface` has an optimized shader, and can accept matrices of deformed grid points, it's **heavily** recommended to use it (or `mesh` if you need the flexibility) over `poly`.
-
-## Planned features
-- A `choropleth` recipe which can read data from the properties of a FeatureCollection
-- helper functions to extract "columns" of a FeatureCollection
-
-## More examples
-```julia
-using GeoJSON, GeoMakie, Makie
-states = download("https://raw.githubusercontent.com/PublicaMundi/MappingAPI/master/data/geojson/us-states.json")
-
-states_geo = GeoJSON.parse(read(states, String))
-
-poly(states_geo, strokecolor = :blue, strokewidth = 1)
-```
-![US simple example](https://user-images.githubusercontent.com/32143268/73116030-c6223500-3efd-11ea-9690-f5a92415c264.png)
+Please see the documentation for examples and basic usage.