Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@juliohm
juliohm committed May 20, 2024
1 parent 467b92c commit 57b3f7a
Showing 1 changed file with 59 additions and 7 deletions.
66 changes: 59 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,76 @@
[![Build Status](https://github.com/JuliaEarth/GeoArtifacts.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaEarth/GeoArtifacts.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/JuliaEarth/GeoArtifacts.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaEarth/GeoArtifacts.jl)

Julia package for loading geospatial artifacts, e.g. datasets, from different databases.
Julia package for loading geospatial artifacts such as datasets from different sources.

## Datasets
## Usage

### GADM
The package is organized in different submodules, which encapsulate the artifacts.

Please check the docstring of each submodule for more information.

### Artifacts

#### GADM

```julia
julia> GADM.get("BRA", depth=1)
27×12 GeoTable over 27 GeometrySet{2,Float64}
┌─────────────┬─────────────┬─────────────┬────────────────────┬──────────────────────┬─────────────┬──────────────────┬──────────────────┬─────────────┬─────────────┬─────────────┬─────────────
│ GID_1 │ GID_0 │ COUNTRY │ NAME_1 │ VARNAME_1 │ NL_NAME_1 │ TYPE_1 │ ENGTYPE_1 │ CC_1 │ HASC_1 │ ISO_1 │ geome ⋯
│ Categorical │ Categorical │ Categorical │ Categorical │ Categorical │ Categorical │ Categorical │ Categorical │ Categorical │ Categorical │ Categorical │ MultiPo ⋯
│ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ ⋯
├─────────────┼─────────────┼─────────────┼────────────────────┼──────────────────────┼─────────────┼──────────────────┼──────────────────┼─────────────┼─────────────┼─────────────┼─────────────
│ BRA.1_1 │ BRA │ Brazil │ Acre │ NA │ NA │ Estado │ State │ NA │ BR.AC │ BR-AC │ Multi(3×Po ⋯
│ BRA.2_1 │ BRA │ Brazil │ Alagoas │ NA │ NA │ Estado │ State │ NA │ BR.AL │ BR-AL │ Multi(2×Po ⋯
│ BRA.3_1 │ BRA │ Brazil │ Amapá │ NA │ NA │ Estado │ State │ NA │ BR.AP │ NA │ Multi(3×Po ⋯
│ BRA.4_1 │ BRA │ Brazil │ Amazonas │ Amazone │ NA │ Estado │ State │ NA │ BR.AM │ BR-AM │ Multi(1×Po ⋯
│ BRA.5_1 │ BRA │ Brazil │ Bahia │ Ba¡a │ NA │ Estado │ State │ NA │ BR.BA │ BR-BA │ Multi(21×P ⋯
│ BRA.6_1 │ BRA │ Brazil │ Ceará │ NA │ NA │ Estado │ State │ NA │ BR.CE │ NA │ Multi(1×Po ⋯
│ BRA.7_1 │ BRA │ Brazil │ Distrito Federal │ NA │ NA │ Distrito Federal │ Federal District │ NA │ BR.DF │ BR-DF │ Multi(1×Po ⋯
│ BRA.8_1 │ BRA │ Brazil │ Espírito Santo │ Espiritu Santo │ NA │ Estado │ State │ NA │ BR.ES │ NA │ Multi(84×P ⋯
│ BRA.9_1 │ BRA │ Brazil │ Goiás │ Goiáz|Goyáz │ NA │ Estado │ State │ NA │ BR.GO │ NA │ Multi(1×Po ⋯
│ BRA.10_1 │ BRA │ Brazil │ Maranhão │ São Luíz de Maranhão │ NA │ Estado │ State │ NA │ BR.MA │ NA │ Multi(61×P ⋯
│ BRA.12_1 │ BRA │ Brazil │ Mato Grosso │ Matto Grosso │ NA │ Estado │ State │ NA │ BR.MT │ BR-MT │ Multi(1×Po ⋯
│ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ ⋱
└─────────────┴─────────────┴─────────────┴────────────────────┴──────────────────────┴─────────────┴──────────────────┴──────────────────┴─────────────┴─────────────┴─────────────┴─────────────
1 column and 16 rows omitted
```
#### NaturalEarth
```julia
julia> GADM.get("BRA", depth = 1)
NaturalEarth.get(identifier)
```
### INMET
#### INMET
```julia
julia> INMET.stations()
566×13 GeoTable over 566 PointSet{3,Float64}
┌─────────────┬─────────────┬─────────────┬─────────────┬─────────────┬────────────────┬─────────────────┬─────────────────────────┬─────────────┬───────────────────────────────┬────────────────
│ TP_ESTACAO │ CD_ESTACAO │ SG_ESTADO │ CD_SITUACAO │ CD_DISTRITO │ CD_OSCAR │ DT_FIM_OPERACAO │ CD_WSI │ SG_ENTIDADE │ DT_INICIO_OPERACAO │ DC_NOM ⋯
│ Categorical │ Categorical │ Categorical │ Categorical │ Categorical │ Categorical │ Missing │ Categorical │ Categorical │ Categorical │ Categori ⋯
│ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnit ⋯
├─────────────┼─────────────┼─────────────┼─────────────┼─────────────┼────────────────┼─────────────────┼─────────────────────────┼─────────────┼───────────────────────────────┼────────────────
│ Automatica │ A422 │ BA │ Pane │ 04 │ 0-2000-0-86765 │ missing │ 0-76-0-2906907000000408 │ INMET │ 2008-07-20T21:00:00.000-03:00 │ ABROLHO ⋯
│ Automatica │ A360 │ CE │ Operante │ 03 │ 0-2000-0-81755 │ missing │ 0-76-0-2300200000000446 │ INMET │ 2009-04-21T21:00:00.000-03:00 │ ACARAU ⋯
│ Automatica │ A657 │ ES │ Operante │ 06 │ 0-2000-0-86827 │ missing │ 0-76-0-3200102000000478 │ INMET │ 2011-09-23T21:00:00.000-03:00 │ AFONSO CLA ⋯
│ Automatica │ A908 │ MT │ Operante │ 09 │ 0-2000-0-86686 │ missing │ 0-76-0-5100201000000157 │ INMET │ 2006-12-15T21:00:00.000-03:00 │ AGUA BO ⋯
│ Automatica │ A756 │ MS │ Operante │ 07 │ 0-2000-0-86812 │ missing │ 0-76-0-5000203000000463 │ INMET │ 2010-08-13T21:00:00.000-03:00 │ AGUA CLA ⋯
│ Automatica │ A045 │ DF │ Operante │ 10 │ 0-2000-0-86716 │ missing │ 0-76-0-5300108000000435 │ INMET │ 2008-10-02T21:00:00.000-03:00 │ AGUAS EMEN ⋯
│ Automatica │ A549 │ MG │ Operante │ 05 │ 0-2000-0-86722 │ missing │ 0-76-0-3101003000000252 │ INMET │ 2007-09-08T21:00:00.000-03:00 │ AGUAS VERM ⋯
│ Automatica │ A534 │ MG │ Operante │ 05 │ 0-2000-0-86803 │ missing │ 0-76-0-3101102000000239 │ INMET │ 2007-08-04T21:00:00.000-03:00 │ AIMORE ⋯
│ Automatica │ A617 │ ES │ Operante │ 06 │ 0-2000-0-86828 │ missing │ 0-76-0-3200201000000125 │ INMET │ 2006-10-24T21:00:00.000-03:00 │ ALEGRE ⋯
│ Automatica │ A826 │ RS │ Operante │ 08 │ 0-2000-0-86975 │ missing │ 0-76-0-4300406000000113 │ INMET │ 2006-09-27T21:00:00.000-03:00 │ ALEGRET ⋯
│ Automatica │ A615 │ ES │ Operante │ 06 │ 0-2000-0-86829 │ missing │ 0-76-0-3200300000000135 │ INMET │ 2006-11-02T21:00:00.000-03:00 │ ALFREDO CH ⋯
│ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ ⋱
└─────────────┴─────────────┴─────────────┴─────────────┴─────────────┴────────────────┴─────────────────┴─────────────────────────┴─────────────┴───────────────────────────────┴────────────────
3 columns and 555 rows omitted
```
### GeoStatsImages.jl
### GeoStatsImages
```julia
julia> GeoArtifacts.image(identifier)
julia> GeoStatsImages.get(identifier)
```

0 comments on commit 57b3f7a

Please sign in to comment.