sklearn-argo-cookbook

Accessing publicly available data from Argo ocean profilers, and using Scikit-learn functions to train machine learning models.

https://github.com/projectpythia/sklearn-argo-cookbook

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Accessing publicly available data from Argo ocean profilers, and using Scikit-learn functions to train machine learning models.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 5
  • Open Issues: 4
  • Releases: 0
Created almost 2 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

Scikit-learn on Argo Observations

thumbnail

nightly-build Binder DOI

This Project Pythia Cookbook covers two objectives:

  1. Accessing publicly available, quality-controlled Biogeochemical-Argo ocean observations
  2. Demonstrating uses of scikit-learn, a powerful Python package for machine learning.

Motivation

This cookbook provides an overview of how to use python to access Argo oceanographic data and how to use sklearn to perform machine learning analyses. Argo is a global observatory of in situ robots that autonomously sample the ocean interior. It is an international collaborative effort, and provides a treasure trove of high quality, open-source data. However, there are many different ways to access Argo data, which can get confusing for users. This cookbook highlights some basic workflows to access and work with Argo data.

Authors

Song Sangmin, Michael Chen.

Contributors

Structure

This cookbook is broken up into two main sections.

  1. Argo Foundations
  2. Scikit-learn Workflows

Section 1: Argo Foundations

This section contains two notebooks. argo-introductions.ipynb provides an overview of the Argo program, what kind of data are available, and how the data are structured. The argo-access.ipynb provides an overview of several methods to retrieve Argo data.

Section 2: Scikit-learn Workflows

This section provides an overview of workflows using the sklearn package to conduct machine learning analyses on Argo data. The notebooks provide workflows on running regression and clustering (under construction) analyses.

Running the Notebooks

You can either run the notebook using Binder or on your local machine.

Running on Binder

The simplest way to interact with a Jupyter Notebook is through Binder, which enables the execution of a Jupyter Book in the cloud. The details of how this works are not important for now. All you need to know is how to launch a Pythia Cookbooks chapter via Binder. Simply navigate your mouse to the top right corner of the book chapter you are viewing and click on the rocket ship icon, (see figure below), and be sure to select “launch Binder”. After a moment you should be presented with a notebook that you can interact with. I.e. you’ll be able to execute and even change the example programs. You’ll see that the code cells have no output at first, until you execute them by pressing {kbd}Shift+{kbd}Enter. Complete details on how to interact with a live Jupyter notebook are described in Getting Started with Jupyter.

Running on Your Own Machine

If you are interested in running this material locally on your computer, you will need to follow this workflow:

(Replace "cookbook-example" with the title of your cookbooks)

  1. Clone the https://github.com/ProjectPythia/cookbook-example repository:

bash git clone https://github.com/ProjectPythia/cookbook-example.git

  1. Move into the cookbook-example directory bash cd cookbook-example
  2. Create and activate your conda environment from the environment.yml file bash conda env create -f environment.yml conda activate cookbook-example
  3. Move into the notebooks directory and start up Jupyterlab bash cd notebooks/ jupyter lab

Owner

  • Name: Project Pythia
  • Login: ProjectPythia
  • Kind: organization
  • Email: projectpythia@ucar.edu
  • Location: United States of America

Community learning resource for Python-based computing in the geosciences

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this cookbook, please cite it as below."
authors:
  # add additional entries for each author -- see https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md
  - family-names: Song
    given-names: Sangmin
    orcid: https://orcid.org/0009-0001-1339-2555 # optional
    website: https://github.com/song-sangmin # optional
    affiliation: University of Washington
  - family-names: Kent
    given-names: Julia
    orcid: https://orcid.org/0000-0002-5611-8986
    website: https://github.com/jukent
    affiliation: UCAR/NCAR
  - family-names: Tyle
    given-names: Kevin
    orcid: https://orcid.org/0000-0001-5249-9665
    website: https://github.com/ktyle
    affiliation: University at Albany (State University of New York)
  - family-names: Clyne
    given-names: John
    orcid: https://orcid.org/0000-0003-2788-9017
    website: https://github.com/clyne
    affiliation: UCAR/NCAR
  - family-names: Camron
    given-names: Drew
    orcid: https://orcid.org/0000-0001-7246-6502
    website: https://github.com/dcamron
    affiliation: UCAR/Unidata
  - family-names: Grover
    given-names: Maxwell
    orcid: https://orcid.org/0000-0002-0370-8974
    website: https://github.com/mgrover1
    affiliation: Argonne National Laboratory
  - family-names: Ford
    given-names: Robert R.
    orcid: https://orcid.org/0000-0001-5483-4965
    website: https://github.com/r-ford
    affiliation: University at Albany (State University of New York)
  - family-names: Paul
    given-names: Kevin
    orcid: https://orcid.org/0000-0001-8155-8038
    website: https://github.com/kmpaul
    affiliation: NVIDIA
  - name: "Cookbook Template contributors" # use the 'name' field to acknowledge organizations
    website: "https://github.com/song-sangmin/sklearn-argo/graphs/contributors"
title: "Using sklearn on BGC-Argo ocean observations"
abstract: "2024 Project Pythia Hackathon"

GitHub Events

Total
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 60
  • Pull request event: 3
  • Create event: 1
Last Year
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 60
  • Pull request event: 3
  • Create event: 1

Dependencies

.github/workflows/nightly-build.yaml actions
.github/workflows/publish-book.yaml actions
.github/workflows/trigger-book-build.yaml actions
.github/workflows/trigger-delete-preview.yaml actions
.github/workflows/trigger-link-check.yaml actions
.github/workflows/trigger-preview.yaml actions
.github/workflows/trigger-replace-links.yaml actions
  • actions/checkout v4 composite
  • jacobtomlinson/gha-find-replace v3 composite
  • stefanzweifel/git-auto-commit-action v5 composite
environment.yml pypi
  • argovisHelpers ==0.0.26
  • matplotlib-label-lines *