From d6695169c8d02ecaa3592bc97de8f1d2d1b0a86e Mon Sep 17 00:00:00 2001 From: dpabon <13040959+dpabon@users.noreply.github.com> Date: Tue, 6 Dec 2022 13:21:16 +0100 Subject: [PATCH 1/4] how to concatenate cubes added to the documentation --- docs/examples/HowdoI/concatenatecubes.jl | 36 ++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/examples/HowdoI/concatenatecubes.jl diff --git a/docs/examples/HowdoI/concatenatecubes.jl b/docs/examples/HowdoI/concatenatecubes.jl new file mode 100644 index 000000000..6a7cb4255 --- /dev/null +++ b/docs/examples/HowdoI/concatenatecubes.jl @@ -0,0 +1,36 @@ +# !!! question +# How do I concatenate cubes? + + +# It is possible to concatenate several cubes that shared the same dimmensions using the [`concatenatecubes`]@ref function. + +# let's create two dummy cubes + +using YAXArrays + +axlist = [ + RangeAxis("time", range(1, 20, length=20)), + RangeAxis("lon", range(1, 10, length=10)), + RangeAxis("lat", range(1, 5, length=15))] + +data1 = rand(20, 10, 15) + +ds1 = YAXArray(axlist, data1) + +data2 = rand(20, 10, 15) + +ds2 = YAXArray(axlist, data2) + + +# Now we can concatenate ```ds1``` and ```ds2``` cubes: + +dsfinal = concatenatecubes([ds1, ds2], CategoricalAxis("Variables", ["var1", "var2"])) + +#```julia +# YAXArray with the following dimensions +# time Axis with 20 Elements from 1.0 to 20.0 +# lon Axis with 10 Elements from 1.0 to 10.0 +# lat Axis with 15 Elements from 1.0 to 5.0 +# Variables Axis with 2 elements: var1 var2 +# Total size: 46.88 KB +#``` From f4ce3590d125f872cc04d0cb47794dcaa10adaa4 Mon Sep 17 00:00:00 2001 From: dpabon <13040959+dpabon@users.noreply.github.com> Date: Tue, 6 Dec 2022 13:23:12 +0100 Subject: [PATCH 2/4] 'how to concatenate cubes' added to the documentation --- docs/examples/HowdoI/concatenatecubes.jl | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/docs/examples/HowdoI/concatenatecubes.jl b/docs/examples/HowdoI/concatenatecubes.jl index 6a7cb4255..f190f577a 100644 --- a/docs/examples/HowdoI/concatenatecubes.jl +++ b/docs/examples/HowdoI/concatenatecubes.jl @@ -26,11 +26,4 @@ ds2 = YAXArray(axlist, data2) dsfinal = concatenatecubes([ds1, ds2], CategoricalAxis("Variables", ["var1", "var2"])) -#```julia -# YAXArray with the following dimensions -# time Axis with 20 Elements from 1.0 to 20.0 -# lon Axis with 10 Elements from 1.0 to 10.0 -# lat Axis with 15 Elements from 1.0 to 5.0 -# Variables Axis with 2 elements: var1 var2 -# Total size: 46.88 KB -#``` +dsfinal \ No newline at end of file From f8988de0d14e9f43d1b4e3402d97b32ed19addcc Mon Sep 17 00:00:00 2001 From: Daniel Pabon <13040959+dpabon@users.noreply.github.com> Date: Tue, 6 Dec 2022 13:34:36 +0100 Subject: [PATCH 3/4] typo fixed --- docs/examples/HowdoI/concatenatecubes.jl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/examples/HowdoI/concatenatecubes.jl b/docs/examples/HowdoI/concatenatecubes.jl index f190f577a..e44745081 100644 --- a/docs/examples/HowdoI/concatenatecubes.jl +++ b/docs/examples/HowdoI/concatenatecubes.jl @@ -2,7 +2,7 @@ # How do I concatenate cubes? -# It is possible to concatenate several cubes that shared the same dimmensions using the [`concatenatecubes`]@ref function. +# It is possible to concatenate several cubes that shared the same dimensions using the [`concatenatecubes`]@ref function. # let's create two dummy cubes @@ -26,4 +26,4 @@ ds2 = YAXArray(axlist, data2) dsfinal = concatenatecubes([ds1, ds2], CategoricalAxis("Variables", ["var1", "var2"])) -dsfinal \ No newline at end of file +dsfinal From b31284a7964d8f8b8822cb8c7b12ffe213dacf4d Mon Sep 17 00:00:00 2001 From: Lazaro Alonso Date: Tue, 6 Dec 2022 16:19:55 +0100 Subject: [PATCH 4/4] fix docs --- docs/examples/HowdoI/extract_axes_names.jl | 6 ------ .../HowdoI/{concatenatecubes.jl => howdoi.jl} | 20 ++++++++++++++----- docs/mkdocs.yml | 3 +-- 3 files changed, 16 insertions(+), 13 deletions(-) delete mode 100644 docs/examples/HowdoI/extract_axes_names.jl rename docs/examples/HowdoI/{concatenatecubes.jl => howdoi.jl} (60%) diff --git a/docs/examples/HowdoI/extract_axes_names.jl b/docs/examples/HowdoI/extract_axes_names.jl deleted file mode 100644 index 1d6fc31b0..000000000 --- a/docs/examples/HowdoI/extract_axes_names.jl +++ /dev/null @@ -1,6 +0,0 @@ -# !!! question -# How do I extract the axes names from a Cube? - -using YAXArrays -c = YAXArray(rand(10,10,5)) -caxes(c) \ No newline at end of file diff --git a/docs/examples/HowdoI/concatenatecubes.jl b/docs/examples/HowdoI/howdoi.jl similarity index 60% rename from docs/examples/HowdoI/concatenatecubes.jl rename to docs/examples/HowdoI/howdoi.jl index e44745081..74d9487ee 100644 --- a/docs/examples/HowdoI/concatenatecubes.jl +++ b/docs/examples/HowdoI/howdoi.jl @@ -1,6 +1,18 @@ +# The purpose of this section is to do a collection of small +# convinient pieces of code on how to do simple things. + +# !!! question + +# ## extract the axes names from a Cube? + +using YAXArrays +c = YAXArray(rand(10,10,5)) + +caxes(c) + # !!! question -# How do I concatenate cubes? +# ## concatenate cubes? # It is possible to concatenate several cubes that shared the same dimensions using the [`concatenatecubes`]@ref function. @@ -14,16 +26,14 @@ axlist = [ RangeAxis("lat", range(1, 5, length=15))] data1 = rand(20, 10, 15) - ds1 = YAXArray(axlist, data1) data2 = rand(20, 10, 15) - ds2 = YAXArray(axlist, data2) - # Now we can concatenate ```ds1``` and ```ds2``` cubes: -dsfinal = concatenatecubes([ds1, ds2], CategoricalAxis("Variables", ["var1", "var2"])) +dsfinal = concatenatecubes([ds1, ds2], + CategoricalAxis("Variables", ["var1", "var2"])) dsfinal diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index c79bceb56..906b54433 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -113,6 +113,5 @@ nav: - "Simple maps": "examples/generated/Gallery/simplemaps.md" - "Tutorials": - "Tutorial": "tutorials/tutorial.md" - - "How do I ...": - - "Extract axes names": "examples/generated/HowdoI/extract_axes_names.md" + - "How do I ...": "examples/generated/HowdoI/howdoi.md" - "API" : "api.md" \ No newline at end of file