Skip to content

Commit

Permalink
Merge pull request #304 from JuliaDataCubes/copy_code
Browse files Browse the repository at this point in the history
Copy code
  • Loading branch information
lazarusA authored Aug 5, 2023
2 parents cd7ebb6 + 4af55a1 commit 2442b9d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 21 deletions.
27 changes: 8 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,10 @@
<div align="center">
# 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*

</div>

<img align="left" width=200 src="docs/src/assets/logo.png">

<div align="center">

| **Documentation** | **Build Status** |
|:-------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|
| [![][docs-dev-img]][docs-dev-url] | [![][ci-img]][ci-url] [![][codecov-img]][codecov-url] |
| | [![][coveralls-img]][coveralls-url] |

</div>
<img src="docs/src/assets/logo.png" align="right" style="padding-left:10px;" width="150"/>

[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
[docs-dev-url]: https://JuliaDataCubes.github.io/YAXArrays.jl/dev/
Expand All @@ -27,27 +18,25 @@
[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.
See the [DimensionalData.jl docs](https://rafaqz.github.io/DimensionalData.jl/stable/) and the `Switch to DimensionalData section in our docs.

# Installation


Install the YAXArrays package:
```julia
julia>]
pkg> add YAXArrays
```
<br> </br>

You may check the installed version with:
```julia
Expand Down
5 changes: 3 additions & 2 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 2442b9d

Please sign in to comment.