diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 0000000..bde524c --- /dev/null +++ b/docs/about.md @@ -0,0 +1,10 @@ +# About + +## Authors +Following authors contributed to the `geokube` framework. + +| Authors | +|--------------------| +| Marco Mancini ORCID logo | +| Mirko Stojiljković ORCID logo | +| Jakub Walczak ORCID logo | diff --git a/docs/axis.md b/docs/axis.md new file mode 100644 index 0000000..8944ee6 --- /dev/null +++ b/docs/axis.md @@ -0,0 +1 @@ +::: geokube.core.axis \ No newline at end of file diff --git a/docs/coord_system.md b/docs/coord_system.md new file mode 100644 index 0000000..e32cb0e --- /dev/null +++ b/docs/coord_system.md @@ -0,0 +1 @@ +::: geokube.core.coord_system \ No newline at end of file diff --git a/docs/crs.md b/docs/crs.md new file mode 100644 index 0000000..0bf8262 --- /dev/null +++ b/docs/crs.md @@ -0,0 +1 @@ +::: geokube.core.crs \ No newline at end of file diff --git a/docs/domain.md b/docs/domain.md new file mode 100644 index 0000000..36b4de2 --- /dev/null +++ b/docs/domain.md @@ -0,0 +1 @@ +::: geokube.core.domain \ No newline at end of file diff --git a/docs/feature.md b/docs/feature.md new file mode 100644 index 0000000..89efca3 --- /dev/null +++ b/docs/feature.md @@ -0,0 +1 @@ +::: geokube.core.feature \ No newline at end of file diff --git a/docs/field.md b/docs/field.md new file mode 100644 index 0000000..60b74e3 --- /dev/null +++ b/docs/field.md @@ -0,0 +1 @@ +::: geokube.core.field \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..41fbba3 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,5 @@ +# Welcome to geokube + +**geokube** is an open source Python package for geoscience data analysis that provides the user with a simple application programming interface (API) for performing geospatial operations (e.g., extracting a bounding box or regridding) and temporal operations (e.g., resampling) on different types of scientific feature types like grids, profiles and points, using on `xarray` data structures like `xarray.Dataset` and custom `xarray.Dataset.indexes` and xarray ecosystem frameworks such as `xesmf` and `cf-xarray`. + +Furthermore, based on xarray IO engines, geokube provides built-in drivers for reading geoscientific datasets produced by Earth Observations (e.g. satellite data) and Earth Systems Models (e.g., weather, climate and oceanographic models) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..0a7745e --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,40 @@ +site_name: geokube +site_description: geokube - a Python package based on xarray for Geoscience Data Analysis and Visualization +theme: + name: material + palette: + - media: '(prefers-color-scheme: light)' + scheme: default + primary: blue grey + accent: amber + features: + - search.suggest + - search.highlight + - content.tooltips + - content.code.annotate + - content.code.copy + - content.code.select + icon: + repo: fontawesome/brands/github-alt + logo: img/favicon.svg + favicon: img/favicon.svg + language: en +repo_name: CMCC-Foundation/geolake +repo_url: https://github.com/CMCC-Foundation/geokube +edit_uri: '' +use_directory_urls: false + +plugins: +- mkdocstrings: + +nav: +- geokube: index.md +- API: + - axis.md + - crs.md + - coord_system.md + - feature.md + - domain.md + - field.md +- about.md +