Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Ocean data view tutorial and new topic #4405

Merged
merged 47 commits into from
Nov 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
23af6b5
Add files via upload
Marie59 Oct 10, 2023
45f87ca
Add 1st tuto earth system
Marie59 Oct 10, 2023
b4bc486
Merge branch 'galaxyproject:main' into odv
Marie59 Oct 11, 2023
b734748
Delete topics/earth-system/docker directory
Marie59 Oct 11, 2023
81f8627
rm docker
Marie59 Oct 11, 2023
357d75d
Update tutorial.md
Marie59 Oct 12, 2023
02d15e9
Merge branch 'main' into odv
shiltemann Oct 13, 2023
aefcfad
add symlink to topic metadata
shiltemann Oct 13, 2023
40bfe19
add fair-ease logo
Marie59 Oct 16, 2023
90e8c59
add fairease funder
Marie59 Oct 16, 2023
4e3072f
add funding
Marie59 Oct 16, 2023
bd7f0a6
update contributions
Marie59 Oct 16, 2023
e10aac2
editorial_board fix
Marie59 Oct 16, 2023
c486561
bad copy paste fix
Marie59 Oct 16, 2023
7f74585
add esg logo
Marie59 Oct 16, 2023
b3c651e
add eurosciencegateway as funder
Marie59 Oct 16, 2023
15119d4
add esg funding
Marie59 Oct 16, 2023
2abc824
Update CONTRIBUTORS.yaml
Marie59 Oct 16, 2023
a797465
Update CONTRIBUTORS.yaml
Marie59 Oct 16, 2023
51f802b
add double quote
Marie59 Oct 16, 2023
88ca8b6
add image
Marie59 Oct 16, 2023
17d380a
fix image path
Marie59 Oct 16, 2023
03e31cf
Update topics/earth-system/tutorials/ocean-data-view/tutorial.md
Marie59 Oct 17, 2023
c40fc2d
Update topics/earth-system/tutorials/ocean-data-view/tutorial.md
Marie59 Oct 17, 2023
b87a94c
Update topics/earth-system/tutorials/ocean-data-view/tutorial.md
Marie59 Oct 17, 2023
4646e74
Update topics/earth-system/tutorials/ocean-data-view/tutorial.md
Marie59 Oct 17, 2023
33be8cc
Update topics/earth-system/tutorials/ocean-data-view/tutorial.md
Marie59 Oct 17, 2023
17418a7
Update topics/earth-system/tutorials/ocean-data-view/tutorial.md
Marie59 Oct 17, 2023
da75055
Update topics/earth-system/tutorials/ocean-data-view/tutorial.md
Marie59 Oct 17, 2023
703b5cb
Update topics/earth-system/tutorials/ocean-data-view/tutorial.md
Marie59 Oct 17, 2023
964349f
Update topics/earth-system/tutorials/ocean-data-view/tutorial.md
Marie59 Oct 17, 2023
12544c7
Delete topics/earth-system/images/coastal_water_dyn/galaxy_interface.png
Marie59 Oct 17, 2023
124170c
add bib
Marie59 Oct 17, 2023
332a101
add argo citation
Marie59 Oct 17, 2023
5791ea8
add faqs
Marie59 Oct 17, 2023
4fc99d4
Delete topics/earth-system/tutorials/ocean-data-view/faqs directory
Marie59 Oct 17, 2023
c44ddb2
add faqs
Marie59 Oct 17, 2023
ed0e8bc
add image for odv tuto
Marie59 Nov 20, 2023
26d6c94
add odv tuto
Marie59 Nov 20, 2023
6855f9d
Delete topics/earth-system directory
Marie59 Nov 20, 2023
c86df17
Update metadata.yaml
Marie59 Nov 20, 2023
6f74f1b
small fix for ODV update
Marie59 Nov 24, 2023
c4c40d4
Delete topics/climate/images/coastal_water_dyn/outputs.png
Marie59 Nov 24, 2023
c6df42c
Merge branch 'main' into odv
bgruening Nov 27, 2023
e9954b1
move funders to funding file
bgruening Nov 27, 2023
38256af
add fairease and ESG to funders
bgruening Nov 27, 2023
fcd5abf
Delete metadata/earth-system.yaml
bgruening Nov 27, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTRIBUTORS.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1035,6 +1035,7 @@ mariecrane:
Marie59:
name: Marie Josse
joined: 2022-03
email: [email protected]

MarisaJL:
name: Marisa Loach
Expand Down
25 changes: 25 additions & 0 deletions FUNDERS.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -213,3 +213,28 @@ ukmrc:
avatar: https://raw.githubusercontent.com/nomadscientist/scrnaseq_training/master/logo.png
github: false
funder: true

fairease:
name: Fair-Ease
github: false
joined: 2023-10
avatar: "/training-material/assets/images/fair_ease_colour.png"
url: https://fairease.eu/
funder: true
funding_id: "101058785"
funding_system: cordis
funding_statement: |
FAIR-EASE is a RIA project funded under HORIZON-INFRA-2021-EOSC-01-04, and it involves a consortium of 25 partners from all over Europe.

eurosciencegateway:
name: EuroScienceGateway
github: false
joined: 2023-10
avatar: "/training-material/assets/images/eurosciencegateway.png"
url: https://galaxyproject.org/projects/esg/
funder: true
funding_id: "101057388"
funding_system: cordis
funding_statement: |
EuroScienceGateway was funded by the European Union programme Horizon Europe (HORIZON-INFRA-2021-EOSC-01-04) under grant agreement number 101057388 and by UK Research and Innovation (UKRI) under the UK government’s Horizon Europe funding guarantee grant number 10038963.

Binary file added assets/images/eurosciencegateway.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/fair_ease_colour.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added topics/climate/images/coastal_water_dyn/eu_fe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added topics/climate/images/coastal_water_dyn/map.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions topics/climate/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,13 @@ requirements:
docker_image: ''
editorial_board:
- annefou

---
name: "earth-system"
type: "use"
title: "Earth System"
summary: "Learn to access, analyze and visualise Earth System data"
tag_based: true

editorial_board:
- Marie59
53 changes: 53 additions & 0 deletions topics/climate/tutorials/ocean-data-view/tutorial.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@

# This is the bibliography file for your tutorial.
#
# To add bibliography (bibtex) entries here, follow these steps:
# 1) Find the DOI for the article you want to cite
# 2) Go to https://doi2bib.org and fill in the DOI
# 3) Copy the resulting bibtex entry into this file
#
# To cite the example below, in your tutorial.md file
# use {% cite Batut2018 %}
#
# If you want to cite an online resourse (website etc)
# you can use the 'online' format (see below)
#
# You can remove the examples below

@article{Batut2018,
doi = {10.1016/j.cels.2018.05.012},
url = {https://doi.org/10.1016/j.cels.2018.05.012},
year = {2018},
month = jun,
publisher = {Elsevier {BV}},
volume = {6},
number = {6},
pages = {752--758.e1},
author = {B{\'{e}}r{\'{e}}nice Batut and Saskia Hiltemann and Andrea Bagnacani and Dannon Baker and Vivek Bhardwaj and
Clemens Blank and Anthony Bretaudeau and Loraine Brillet-Gu{\'{e}}guen and Martin {\v{C}}ech and John Chilton
and Dave Clements and Olivia Doppelt-Azeroual and Anika Erxleben and Mallory Ann Freeberg and Simon Gladman and
Youri Hoogstrate and Hans-Rudolf Hotz and Torsten Houwaart and Pratik Jagtap and Delphine Larivi{\`{e}}re and
Gildas Le Corguill{\'{e}} and Thomas Manke and Fabien Mareuil and Fidel Ram{\'{i}}rez and Devon Ryan and
Florian Christoph Sigloch and Nicola Soranzo and Joachim Wolff and Pavankumar Videm and Markus Wolfien and
Aisanjiang Wubuli and Dilmurat Yusuf and James Taylor and Rolf Backofen and Anton Nekrutenko and Bj\"{o}rn Gr\"{u}ning},
title = {Community-Driven Data Analysis Training for Biology},
journal = {Cell Systems}
}

@online{gtn-website,
author = {GTN community},
title = {GTN Training Materials: Collection of tutorials developed and maintained by the worldwide Galaxy community},
url = {https://training.galaxyproject.org},
urldate = {2021-03-24}
}

@misc{argodata,
doi = {10.17882/42182},
url = {https://www.seanoe.org/data/00311/42182/},
author = {{Argo}},
keywords = {float, Argo, global ocean observing system, ocean circulation, in-situ, ocean pressure, sea water salinity, sea water temperature, multi-year, weather climate and seasonal observation, global-ocean},
title = {Argo float data and metadata from Global Data Assembly Centre (Argo GDAC)},
publisher = {SEANOE},
year = {2023},
copyright = {Creative Commons Attribution 4.0 International}
}
249 changes: 249 additions & 0 deletions topics/climate/tutorials/ocean-data-view/tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,249 @@
---
layout: tutorial_hands_on

title: Ocean Data View (ODV)
questions:
- How to process Argo's glider data ?
- How to visualise the glider's stations
- How to use make salinity temperature profiles for one or more stations ?
objectives:
- Deal with netcdf files in ODV
- Visualise ocean variables from Argo glider's data
time_estimation: 1H
key_points:
- Manage Argo glider's data and learn to process netcdf data.
- Build a map of the stations and create profiles curves with ODV
- Learn to use ODV as Galaxy interactive tool
tags:
- earth-system
- ocean
- geographical information system
- ODV
- netcdf data
- maps
- marine data
contributions:
authorship:
- Marie59
funding:
- fairease
- eurosciencegateway
---


# Introduction


Through this tutorial you will learn here how to access, filter and import netCDF data through using ODV Galaxy interactive tool:

Ocean Data View (ODV) is a software package for the interactive exploration, analysis and visualization of oceanographic and other geo-referenced profile, time-series, trajectory or sequence data. To know more about ODV go check the [official page](https://odv.awi.de/)

> <agenda-title></agenda-title>
>
> In this tutorial, we will cover:
>
> 1. TOC
> {:toc}
>
{: .agenda}

# Managing ODV Galaxy interactive tool
ODV is now integrated in Galaxy as an interactive tool. This kind of tools is working differently than classical tools as it allows the user to interact with a dedicated graphical interface. This kind of tools is used to give access to Jupyter notebooks, RStudio or R Shiny apps for example.

To use ODV, you need to use the {% tool [dedicated form](interactive_tool_odv) %}, you can specify input datasets from your hisrtory you want to use in ODV, then press the **execute** button to launch a ODV instance. When the graphical user interface of ODV is ready to be used, a URL will be displayed at the top of the Galaxy center panel. If you don't see it, you can see and access it through the "Active InteractiveTools" space of the "User" menu or you can click on {% icon galaxy-eye %} on the tool in the history.

Once you finished your work on ODV, if you want to retrieve data and/or entire project, you need to save files in ODV/galaxy/outputs, then quit ODV properly through the "Project" Menu tab.

> <details-title>Short introduction on how Galaxy works</details-title>
>
> You can come back to where you left off the tutorial anytime by clicking {% icon level %}.
>
> > <hands-on-title>Log in to Galaxy</hands-on-title>
> > 1. Open your favorite browser (Chrome, Safari or Firefox as your browser, not Internet Explorer!)
> > 2. Browse to your [Galaxy instance](https://earth-system.usegalaxy.eu/)
> > 3. On the top pannel go to **Login or Register**
> >
> >
> {: .hands_on}
>
> The Galaxy homepage is divided into three panels:
> * Tools on the left
> * Viewing panel in the middle
> * History of analysis and files on the right
>
> ![Screenshot of the Galaxy interface, the tools panel is on the left, the main panel is in the center, and the history is on the right.]({% link shared/images/galaxy_interface.png %} "Galaxy interface explanation")
>
> The first time you use Galaxy, there will be no files in your history panel.
{: .details}


> <hands-on-title>Deploy your own ODV instance</hands-on-title>
>
> 1. Create a new history for this tutorial nd give it a name (example: “ODV for Argo”) for you to find it again later if needed.
>
> {% snippet faqs/galaxy/histories_create_new.md %}
>
> 2. Import netCDF data from amazonaws with this link an rename it "1900392_prof.nc" instead of "New File"
>
> ```
> https://argo-gdac-sandbox.s3-eu-west-3.amazonaws.com/pub/dac/coriolis/1900392/1900392_prof.nc
> ```
> {% snippet faqs/galaxy/datasets_import_via_link.md %}
>
> 3. *"Select if you are using a ODV collection in a zip folder or if you have your own raw data"*: `The data you are using are a Netdcdf or tabular text files`
> 4. Select your new data before deploying {% tool [ODV instance](interactive_tool_odv) %} by pressing **execute**
> 5. Access ODV
>
> {% snippet faqs/galaxy/interactive_tools_open.md tool="ODV" %}
>
{: .hands_on}

> <details-title> Some complementary information about your data </details-title>
> Argo is an international program to observe the interior of the ocean with a fleet of profiling floats drifting in the deep ocean currents (check it [out on the argo site](https://argo.ucsd.edu)). Argo GDAC is a dataset of 5 billion in situ ocean observations from 18.000 profiling floats (4.000 active) which started 20 years ago. Argo GDAC dataset is a collection of 18.000 NetCDF files. It is a major asset for ocean and climate science, a contributor to IOCCP reports. {% cite argodata %}
>
> These data are available on AWS registry of Open Data. This registry exists to help people discover and share datasets that are available via AWS resources. [See recent additions and learn more about sharing data on AWS](https://registry.opendata.aws/).
{: .details}

# Ocean Data View
## Map your data

> <tip-title>Copy pasting between computer and ODV</tip-title>
> You can expand the ODV left panel (where there are 3 dots, vertically) to access the "clipboard" menu, and paste the content you want to paste on a ODV form. From there you can copy paste everything from one side to the other. Then, click outside of this panel to collapse it.
>
> ![Image showing in transparent on the left of the ODV interface the clipboard](../../images/coastal_water_dyn/clipboard.png)
{: .tip}

> <tip-title>ODV - Disconnected</tip-title>
> If at one point your ODV interface becomes grey with a red panel "X ODV - Disconnected", do NOT panic ;) you just need to reload your tab (circular arrow top left)
{: .tip}

> <hands-on-title>Loading Argo data</hands-on-title>
>
> 1. Go to the top left of ODV and click on "Open..."
> 2. Click on "1900392_prof.nc" of the pop-up screen and on **Open**
> 3. Press **Next >** for "Select Dimensions (Step 1 of 4)"
> 4. Press **Next >** for "Associate Meta Variables (Step 2 of 4)"
> 5. Press **Next >** for "Select Primary Variable (Step 3 of 4)"
> 6. Press **Finish** for "Subset Dimensions (Step 4 of 4)"
> 7. "Enter netCDF Setup Name:" write "argo_prof_data", then, press **OK**
{: .hands_on}
![Map of all the stations of the Argo glider](../../images/coastal_water_dyn/argo_stations.png)

> <question-title></question-title>
>
> 1. What are the longitude and latitude of the red dot ?
>
> > <solution-title></solution-title>
> >
> > 1. On the to right window you can read Longitude 7°E and Latitude 21°S.
> >
> {: .solution}
>
{: .question}

## Create profiles curves

> <hands-on-title>Create a multiple windows view</hands-on-title>
> 1. On the top left press **+**
> 2. Click on **2 Station Windows**
> ![Image showing where to go to have the 2 STATION Windows](../../images/coastal_water_dyn/2_station.png)
> 3. Two more slots appear follow the indication and press + on your keyboard (or SHIFT and +).
>
> Here you have created a multiple view on ODV
{: .hands_on}

> <hands-on-title>Create profiles</hands-on-title>
> 1. On the biggest window click on the right side of your mousse
> 2. Select **X-Variable**, press **TEMP [degree_Celsius]** and OK.
> ![Image of the selection of the pression](../../images/coastal_water_dyn/xvar_temp.png)
> 3. Select **Y-Variable**, press **PRES [decibar]** and OK. Your profile is now uspide down.
> 4. To correct that click right again go on **Y-Variable** and on the bottom of the pop-up screen check the box "Reverse range" and OK.
> ![ODV interface with the map and the 1st profile pression temperature](../../images/coastal_water_dyn/1st_profile.png)
> 5. For the smallest window do the same but for the abscisse select **TEMP_ADJUSTED [degree_Celsius]**. This can be usefull to compare the 2 curves.
> ![Resulting image of the 2 windows configurated](../../images/coastal_water_dyn/2_profiles.png)
>
> You now know how to create multiple profiles curves on ODV from netCDF data.
{: .hands_on}

> <question-title></question-title>
>
> How do you do if you want to compare the profiles with another station ?
>
> > <solution-title></solution-title>
> >
> > With your keyboard you can use the arrows left and right and go through the different stations one-by-one.
> > ![See the profiles of another station](../../images/coastal_water_dyn/2_curves.png)
> >
> {: .solution}
>
{: .question}

> <hands-on-title>Change the station of reference</hands-on-title>
> 1. Go on the map on the bottom left
> 2. Click right and select **Station Filter**
> ![Image on how to select the option Station Filter](../../images/coastal_water_dyn/station_filter.png)
> 3. Then, select and click on **Customize**
> 4. In "Station ID" write the number of the new station of reference (both boxes)
>
> Everything has dissapeared !!! Don't panik it's totally normal ;)
> - Press **+** on your keyboard (or SHIFT and +)
>
> The curves reapeared ! And they correspond to your knew station of reference !
>
> To make the other stations reapear, to allow you to navigate in the other stations while conserving your new station of reference, go on the map once again.
> 6. Click right and select **Station Filter**
> 7. This time select and click on **Relax**
>
> And now you're back with all your stations visible !
{: .hands_on}

## Create one single sum-up profile curve
> <hands-on-title>Create a scatter plot</hands-on-title>
> 1. On the top left press **+**
> 2. Select **1 SCATTER Window** another tab opens (you now have 3 of them)
> ![Image of the new open tab for the preparation of a scatter view](../../images/coastal_water_dyn/scatter_prep.png)
> 1. On the window click on the right side of your mousse
> 4. Select **X-Variable**, press **TEMP [degree_Celsius]** and OK.
> 5. Select **Y-Variable**, press **PRES [decibar]**, at the bottom of the pop-up check the box "Reverse range" and OK.
> ![Selection of the Pression and check of the Reverse range button on the pop-up image](../../images/coastal_water_dyn/yvar_pres.png)
> You now have the final image with all the curves for each stationside by side. You can navigate in them by using the arrows left/right on your keyboard with the red curve being the station you're on.
> ![Resulting image of the scatter plot](../../images/coastal_water_dyn/final_scatter.png)
{: .hands_on}

> <hands-on-title>Save your analysis</hands-on-title>
> 1. Click right on the scatter image and select **Save plot as**
> 2. In the pop-up select and go in the **ODV/galaxy/outputs** folder
> 3. Once you're in the folder you can rename your scatter plot in "File Name:" by "1900392_prof_scatter"
> 4. You can also change the "Files of type:" by "PNG (*.png *.PNG)
> 5. Click on **Save**, then OK and OK.
> 6. On the map click right and then **Save Map As...**
> 7. Still in the ODV/galaxy/outputs folder, rename it "1900392_prof_map" check that the "Files of type:" is "PNG (*.png *.PNG)
> 8. Click on **Save**, then OK and OK
>
> Now, if you have finished with your analysis you can exit ODV. To do so you need to do it properly.
>
> 9. On th top left click on **File** select **Exit**
> 10. If you want to save the other window also click on **Yes**. Here we don't need it so click **No**.
>
> You can now go back on your Galaxy instance.
{: .hands_on}

Now, after waiting for everything to turn green in your history, you can see 2 new outputs "1900392_prof_scatter" and "1900392_prof_map"

> <hands-on-title>View in Galaxy</hands-on-title>
> In the history panel click on the {% icon galaxy-eye %} (eye) icon of your output.
>
> You can now visualize the outputs in galaxy middle pannel.
{: .hands_on}

![Image in the middle pannel of "1900392_prof_scatter"](../../images/coastal_water_dyn/scatter.png)
![Image in the middle pannel of "1900392_prof_map"](../../images/coastal_water_dyn/map.png)


# Conclusion

Great you now know how to use argo floater data to create profiles curves in Ocean Data View (ODV) within Galaxy.

# Extra information
Coming up soon follow ups tutorials on Coastal Water Dynamics workflow (and other Earth-System related trainings). Keep an {% icon galaxy-eye %} open if you are interested !

Loading