Skip to content

Commit

Permalink
upd readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aplavin committed May 6, 2024
1 parent 65381a3 commit 54f3174
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# AxisKeysExtra.jl

The [AxisKeys.jl](https://github.com/mcabbott/AxisKeys.jl) package provides a nice lightweight `KeyedArray` structure: arrays with keyed/labelled axes, similar to `xarray` in Python.
The [AxisKeys.jl](https://github.com/mcabbott/AxisKeys.jl) package provides a nice lightweight `KeyedArray` structure: arrays with keyed/labelled axes, similar to `xarray` in Python. \
It is being maintained, but proposed new features – even simple and self-contained ones – aren't being added ([see, e.g.](https://github.com/mcabbott/AxisKeys.jl/pull/110)). That's the reason for this package, `AxisKeysExtra.jl`: it extends `AxisKeys` with new convenience functions, conversions, Makie plotting recipes.

The intended usage is to just do `using AxisKeysExtra`: it reexports `AxisKeys`, so one can use both regular `AxisKeys` functionality and functions defined in this package.\
See [the Pluto notebook](https://aplavin.github.io/AxisKeysExtra.jl/test/notebook.html) for details and examples.

0 comments on commit 54f3174

Please sign in to comment.