so-fronts
Full scripts to generate figures for "Defining Southern Ocean fronts using unsupervised classification" https://doi.org/10.5194/os-17-1545-2021
Science Score: 59.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 14 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
3 of 6 committers (50.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.4%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Full scripts to generate figures for "Defining Southern Ocean fronts using unsupervised classification" https://doi.org/10.5194/os-17-1545-2021
Basic Info
- Host: GitHub
- Owner: so-wise
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://so-fronts.readthedocs.io
- Size: 519 MB
Statistics
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 2
- Releases: 4
Topics
Metadata Files
README.md
Defining Southern Ocean fronts using unsupervised classification
Paper: https://doi.org/10.5194/os-17-1545-2021
Preprint: https://doi.org/10.5194/os-2021-40
Presentation at AGU2021: https://doi.org/10.1002/essoar.10507114.1
Short description
In the Southern Ocean, fronts delineate water masses, which correspond to upwelling and downwelling branches of the overturning circulation. Classically, oceanographers define Southern Ocean fronts as a small number of continuous linear features that encircle Antarctica. However, modern observational and theoretical developments are challenging this traditional framework to accommodate more localized views of fronts [Chapman et al. 2020].
Here we present code for implementing two related methods for calculating fronts from oceanographic data. The first method uses unsupervised classification (specifically, Gaussian Mixture Modeling or GMM) and a novel interclass metric to define fronts. This approach produces a discontinuous, probabilistic view of front location, emphasising the fact that the boundaries between water masses are not uniformly sharp across the entire Southern Ocean.
The second method uses Sobel edge detection to highlight rapid changes [Hjelmervik & Hjelmervik, 2019]. This approach produces a more local view of fronts, with the advantage that it can highlight the movement of individual eddy-like features (such as the Agulhas rings).
Chapman, C. C., Lea, M.-A., Meyer, A., Sallee, J.-B. & Hindell, M. Defining Southern Ocean fronts and their influence on biological and physical processes in a changing climate. Nature Climate Change (2020). https://doi.org/10.1038/s41558-020-0705-4
Maze, G. et al. Coherent heat patterns revealed by unsupervised classification of Argo temperature profiles in the North Atlantic Ocean. Progress in Oceanography (2017). https://doi.org/10.1016/j.pocean.2016.12.008, https://doi.org/10.5281/zenodo.3906236
Hjelmervik, K. B. & Hjelmervik, K. T. Detection of oceanographic fronts on variable water depths using empirical orthogonal functions. IEEE Journal of Oceanic Engineering (2019). https://doi.org/10.1109/JOE.2019.2917456
I metric for K=5

Getting started
Make the environment:
bash make envActivate the environment in conda:
bash conda activate ./envChange the settings in
src.constantsto set download location etc.Download data (
get_zip: 1694.64639 s):
bash
python3 src/data_loading/bsose_download.py
- Make I-metric:
bash
python3 src/models/batch_i_metric.py
- Make figures:
bash
python3 main.py
Project Organization
``txt
LICENSE
Makefile <- Makefile with commands likemake envormake `
README.md <- The top-level README for developers using this project.
main.py <- The main python script to run.
|
figures <- .png images with non-enumerated names.
requirements <- Directory containing the requirement files.
setup.py <- makes project pip installable (pip install -e .) so src can be imported from jupyter notebooks etc. | src <- Source code for use in this project. | | init.py <- Makes src a Python module | | data <- KO fronts to plot, other data.
data_loading <- Scripts to download and name data.
models <- Make I-metric and Sobel edge detection directory.
plot <- plotting functions directory
| | plotutils <- plotting utilities directory | | preprocessing <- preprocessing scripts (to transform to density etc.). | | | tests <- Scripts for unit tests of your functions | | | animate.py <- animate i-metric. | constants.py <- contains majority of run parameters that can be changed. | makefigures.py <- make all figures in one long script. | movefigures.py <- Move figures script (now unnecessary). | | Changes figure names to Figure-X.png etc. | timewrapper.py <- time wrapper to time parts of the program.
setup.cfg <- setup configuration file for linting rules ```
Requirements
- Anaconda, with
condaworking in shell. makein shell.- Python 3.6+ (final run for paper used
python==3.8.8)
Project template created by the Cambridge AI4ER Cookiecutter.
Owner
- Name: SO-WISE
- Login: so-wise
- Kind: organization
- Location: Cambridge, UK
- Website: www.DanJonesOcean.com
- Twitter: DanJonesOcean
- Repositories: 2
- Profile: https://github.com/so-wise
The Southern Ocean - Weddell Sea - Ice Shelf State Estimate (SO-WISE)
GitHub Events
Total
- Watch event: 1
Last Year
- Watch event: 1
Committers
Last synced: about 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Simon Thomas | s****2@c****k | 151 |
| Simon Thomas | s****n@s****l | 38 |
| Simon Thomas | s****n@u****k | 3 |
| Simon D.A. Thomas | 3****2 | 2 |
| ai4er-cookiecutter | c****r@h****g | 1 |
| Simon Thomas | s****n@u****k | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: about 2 years ago
All Time
- Total issues: 1
- Total pull requests: 1
- Average time to close issues: about 4 hours
- Average time to close pull requests: less than a minute
- Total issue authors: 1
- Total pull request authors: 1
- Average comments per issue: 1.0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- ZhengYinuo0414 (1)
- DanJonesOcean (1)
Pull Request Authors
- ronygolderku (1)
- sdat2 (1)