diff --git a/README.md b/README.md index 35ca2eee..7c0e9e19 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,10 @@ -
+# YAXArrays.jl +[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/JuliaDataCubes/YAXArrays.jl/blob/main/LICENSE) +[![][docs-dev-img]][docs-dev-url][![][ci-img]][ci-url] [![][codecov-img]][codecov-url] +[![][coveralls-img]][coveralls-url][![Downloads](https://shields.io/endpoint?url=https://pkgs.genieframework.com/api/v1/badge/YAXArrays&label=Downloads)](https://pkgs.genieframework.com?packages=YAXArrays) -*Yet Another XArray-like Julia Package* - -
- - - -
-| **Documentation** | **Build Status** | -|:-------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:| -| [![][docs-dev-img]][docs-dev-url] | [![][ci-img]][ci-url] [![][codecov-img]][codecov-url] | -| | [![][coveralls-img]][coveralls-url] | - -
+ [docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg [docs-dev-url]: https://JuliaDataCubes.github.io/YAXArrays.jl/dev/ @@ -27,13 +18,13 @@ [coveralls-img]: https://coveralls.io/repos/github/JuliaDataCubes/YAXArrays.jl/badge.svg?branch=master [coveralls-url]: https://coveralls.io/github/JuliaDataCubes/YAXArrays.jl?branch=master - -# Summary +## What is YAXArrays.jl? +*Yet Another XArray-like Julia Package* YAXArrays.jl is a package to handle gridded data that is larger than memory. It enables the DiskArray.jl package to access the data lazily and provides `map` and `mapCube` to apply user defined functions on arbitrary subsets of the axes. These computations are also easily parallelized either via Distributed or via Threads. -# Switch to DimensionalData +## Switch to DimensionalData With YAXArrays.jl 0.5 we switched the underlying data type to be a subtype of the DimensionalData.jl types. Therefore the indexing with named dimensions changed to the DimensionalData syntax. @@ -41,13 +32,11 @@ See the [DimensionalData.jl docs](https://rafaqz.github.io/DimensionalData.jl/st # Installation - Install the YAXArrays package: ```julia julia>] pkg> add YAXArrays ``` -

You may check the installed version with: ```julia diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 26336e06..c7a846f4 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,9 +1,10 @@ theme: name: material - logo: assets/view-grid-plus-outline.svg + logo: assets/logo.png features: + - content.code.copy # - announce.dismiss - #- content.code.annotate + - content.code.annotate # - content.tabs.link #- content.tooltips # - header.autohide