Skip to content

Commit

Permalink
build based on 70baf2a
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 20, 2024
1 parent ffefc70 commit 6e1612c
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-20T16:30:20","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-20T16:36:59","documenter_version":"1.8.0"}}
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
3 │ 603253 Africa W. Sahara ESH 906.5 WellKnownBinary{Geom, Vector{UIn…
4 │ 35623680 North America Canada CAN 1.674e6 WellKnownBinary{Geom, Vector{UIn…
5 │ 326625791 North America United States of America USA 1.856e7 WellKnownBinary{Geom, Vector{UIn…</code></pre><p>Writing requires Table like input with geometry columns that are <code>WellKnownBinary</code> from <a href="https://github.com/JuliaGeo/GeoFormatTypes.jl/">GeoFormatTypes.jl</a>, or geometries that support <a href="https://github.com/JuliaGeo/GeoInterface.jl/">GeoInterface.jl</a>.</p><pre><code class="language-julia hljs">julia&gt; GeoParquet.write(&quot;test.parquet&quot;, df, (:geometry,))
test.parquet</code></pre><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="#GeoParquet.read-Tuple{GeoParquet.Parquet2Driver, Union{AbstractString, FilePathsBase.AbstractPath, Parquet2.FileManager}}"><code>GeoParquet.read</code></a></li><li><a href="#GeoParquet.todict-Tuple{JSON3.Object}"><code>GeoParquet.todict</code></a></li><li><a href="#GeoParquet.write"><code>GeoParquet.write</code></a></li></ul><h2 id="API-Documentation"><a class="docs-heading-anchor" href="#API-Documentation">API Documentation</a><a id="API-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#API-Documentation" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GeoParquet.read-Tuple{GeoParquet.Parquet2Driver, Union{AbstractString, FilePathsBase.AbstractPath, Parquet2.FileManager}}" href="#GeoParquet.read-Tuple{GeoParquet.Parquet2Driver, Union{AbstractString, FilePathsBase.AbstractPath, Parquet2.FileManager}}"><code>GeoParquet.read</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">read(fn; kwargs...)::DataFrame</code></pre><p>Read a GeoParquet file as DataFrame. Kwargs are passed to the Parquet2.Dataset constructor.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/GeoParquet.jl/blob/382c82ff48da6bd982506ecabab12477ceb67d83/src/io.jl#L44-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GeoParquet.todict-Tuple{JSON3.Object}" href="#GeoParquet.todict-Tuple{JSON3.Object}"><code>GeoParquet.todict</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><p>Adapted from <code>copy</code> in JSON3, but with String keys instead of Symbols.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/GeoParquet.jl/blob/382c82ff48da6bd982506ecabab12477ceb67d83/src/utils.jl#L10">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GeoParquet.write" href="#GeoParquet.write"><code>GeoParquet.write</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">write(ofn, t, columns=(:geom), crs::Union{GFT.ProjJSON,Nothing}=nothing, bbox::Union{Nothing,Vector{Float64}}=nothing; kwargs...)</code></pre><p>Write a dataframe with a geometry column to a Parquet file. Returns <code>ofn</code> on succes. Keyword arguments are passed to Parquet2 writefile method. The geometry column should be a <code>Vector{GeoFormat.WellKnownBinary}</code> or its elements should support GeoInterface. You can construct one with WellKnownGeometry for geometries that support GeoInterface.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/GeoParquet.jl/blob/382c82ff48da6bd982506ecabab12477ceb67d83/src/io.jl#L5-L11">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Friday 20 December 2024 16:30">Friday 20 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
test.parquet</code></pre><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="#GeoParquet.read-Tuple{GeoParquet.Parquet2Driver, Union{AbstractString, FilePathsBase.AbstractPath, Parquet2.FileManager}}"><code>GeoParquet.read</code></a></li><li><a href="#GeoParquet.todict-Tuple{JSON3.Object}"><code>GeoParquet.todict</code></a></li><li><a href="#GeoParquet.write"><code>GeoParquet.write</code></a></li></ul><h2 id="API-Documentation"><a class="docs-heading-anchor" href="#API-Documentation">API Documentation</a><a id="API-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#API-Documentation" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GeoParquet.read-Tuple{GeoParquet.Parquet2Driver, Union{AbstractString, FilePathsBase.AbstractPath, Parquet2.FileManager}}" href="#GeoParquet.read-Tuple{GeoParquet.Parquet2Driver, Union{AbstractString, FilePathsBase.AbstractPath, Parquet2.FileManager}}"><code>GeoParquet.read</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">read(fn; kwargs...)::DataFrame</code></pre><p>Read a GeoParquet file as DataFrame. Kwargs are passed to the Parquet2.Dataset constructor.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/GeoParquet.jl/blob/70baf2ae9bd8599f7a16ae58236dee428cd5f8a2/src/io.jl#L44-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GeoParquet.todict-Tuple{JSON3.Object}" href="#GeoParquet.todict-Tuple{JSON3.Object}"><code>GeoParquet.todict</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><p>Adapted from <code>copy</code> in JSON3, but with String keys instead of Symbols.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/GeoParquet.jl/blob/70baf2ae9bd8599f7a16ae58236dee428cd5f8a2/src/utils.jl#L10">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GeoParquet.write" href="#GeoParquet.write"><code>GeoParquet.write</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">write(ofn, t, columns=(:geom), crs::Union{GFT.ProjJSON,Nothing}=nothing, bbox::Union{Nothing,Vector{Float64}}=nothing; kwargs...)</code></pre><p>Write a dataframe with a geometry column to a Parquet file. Returns <code>ofn</code> on succes. Keyword arguments are passed to Parquet2 writefile method. The geometry column should be a <code>Vector{GeoFormat.WellKnownBinary}</code> or its elements should support GeoInterface. You can construct one with WellKnownGeometry for geometries that support GeoInterface.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/GeoParquet.jl/blob/70baf2ae9bd8599f7a16ae58236dee428cd5f8a2/src/io.jl#L5-L11">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Friday 20 December 2024 16:36">Friday 20 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 comments on commit 6e1612c

Please sign in to comment.