-
Notifications
You must be signed in to change notification settings - Fork 1
Expand ReadMe #19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Expand ReadMe #19
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,93 @@ | ||
| # Geo | ||
| # Geo.jl | ||
|
|
||
| [](https://JuliaGeo.github.io/Geo.jl/stable/) | ||
| [](https://JuliaGeo.github.io/Geo.jl/dev/) | ||
|
|
||
| [](https://github.com/JuliaGeo/Geo.jl/actions/workflows/CI.yml?query=branch%3Amain) | ||
| [](https://codecov.io/gh/JuliaGeo/Geo.jl) | ||
| [](https://julialang.org/) | ||
|
|
||
| A comprehensive meta package for the JuliaGeo ecosystem that provides easy access to the complete suite of geospatial data processing tools in Julia. | ||
|
|
||
| ## Overview | ||
|
|
||
| Geo.jl is a meta package that aggregates the entire JuliaGeo ecosystem, making it simple to install and use all the essential geospatial libraries in Julia with a single package installation. Instead of manually installing many individual packages, Geo.jl provides a curated collection of compatible, well-tested geospatial tools. | ||
|
|
||
| ## What's Included | ||
|
|
||
| Geo.jl brings together 10+ specialized geospatial packages, organized by functionality: | ||
|
|
||
| ### Core Geospatial Libraries | ||
| - **ArchGDAL** - GDAL bindings for reading/writing geospatial data formats | ||
| - **GeoInterface** - Common interface for geospatial data types | ||
| - **GeometryOps** - Geometric operations and algorithms | ||
| - **LibGEOS** - High-performance geometric operations engine | ||
| - **Proj** - Coordinate reference system transformations | ||
|
|
||
| ### Data Structures & Processing | ||
| - **DimensionalData** - Multi-dimensional labeled arrays | ||
| - **Extents** - Spatial extents and bounding boxes | ||
| - **Rasters** - Raster data handling and analysis | ||
| - **GeoDataFrames** - Geospatial data frames (vector data) | ||
|
|
||
| ### File Format Support | ||
| - **GeoJSON** - GeoJSON format support | ||
| - **GeoParquet** - Parquet format for geospatial data | ||
| - **Shapefile** - ESRI Shapefile support | ||
| - **NCDatasets** - NetCDF data support | ||
| - **ZarrDatasets** - Zarr format support | ||
| - **WellKnownGeometry** - WKT/WKB geometry support | ||
|
|
||
| ### Additional Tools | ||
| - **GeoFormatTypes** - Type definitions for geospatial formats | ||
| - **CommonDataModel** - Common data model for scientific data | ||
|
|
||
| ## Installation | ||
|
|
||
| ```julia | ||
| using Pkg | ||
| Pkg.add("Geo") | ||
| ``` | ||
|
|
||
| ## Quick Start | ||
|
|
||
| ```julia | ||
| using Geo | ||
|
|
||
| # Now you have access to all JuliaGeo packages | ||
| using ArchGDAL, GeoDataFrames, Rasters, GeoJSON | ||
|
|
||
| # Load a raster | ||
| raster = Rasters.Raster("elevation.tif") | ||
|
|
||
| # Read a shapefile | ||
| gdf = GeoDataFrames.read("data.shp") | ||
|
|
||
| # Parse GeoJSON | ||
| geojson = GeoJSON.read("features.geojson") | ||
alex-s-gardner marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| ## Key Benefits | ||
|
|
||
| - **One-Command Setup**: Install all geospatial tools with a single `Pkg.add("Geo")` | ||
| - **Compatibility Guaranteed**: All packages are tested for compatibility | ||
| - **Version Management**: Carefully curated version constraints prevent conflicts | ||
| - **Complete Ecosystem**: Access to the full JuliaGeo toolkit | ||
| - **Easy Updates**: Update all geospatial packages together | ||
|
|
||
|
|
||
| ## Documentation | ||
|
|
||
| - [**Stable Documentation**](https://JuliaGeo.github.io/Geo.jl/stable/) - Latest stable release | ||
| - [**Development Documentation**](https://JuliaGeo.github.io/Geo.jl/dev/) - Current development version | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. | ||
|
|
||
| ## Support | ||
|
|
||
| A meta package for the JuliaGeo ecosystem. | ||
| - **Documentation**: [JuliaGeo.github.io/Geo.jl](https://JuliaGeo.github.io/Geo.jl/) | ||
| - **Issues**: [GitHub Issues](https://github.com/JuliaGeo/Geo.jl/issues) | ||
| - **Discussions**: [GitHub Discussions](https://github.com/JuliaGeo/Geo.jl/discussions) | ||
| - **Julia Discourse**: [JuliaGeo category](https://discourse.julialang.org/c/domain/geo) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.