neutralocean
Calculate neutral surfaces in the ocean, using Python
Science Score: 77.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
Found 2 DOI reference(s) in README -
✓Academic publication links
Links to: sciencedirect.com, wiley.com -
✓Committers with academic emails
1 of 3 committers (33.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.1%) to scientific vocabulary
Repository
Calculate neutral surfaces in the ocean, using Python
Basic Info
- Host: GitHub
- Owner: geoffstanley
- Language: Python
- Default Branch: main
- Size: 10.1 MB
Statistics
- Stars: 37
- Watchers: 5
- Forks: 4
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
neutralocean
Calculate neutral surfaces in the ocean, using Python.
The major task of this software is to calculate omega-surfaces, following the algorithm of Stanley et al. (2021). Omega surfaces are highly accurate approximately neutral surfaces that work by iteratively reducing the neutrality error.
There are also routines to calculate potential density surfaces, specific volume anomaly surfaces, neutral trajectories, the Veronis density label, and measures of neutrality error.
Topobaric surfaces (Stanley, 2019a) in their modified form (Stanley 2019b) are the most accurate approximately neutral surfaces that posses an exact geostrophic streamfunction (furnishing an Ertel potential vorticity with no baroclinic production term). Software to compute topobaric surfaces is significantly more complicated and is currently only available in the original MATLAB neutral-surfaces toolbox.
How to cite? If you use this software, the most appropriate paper to cite is Stanley et al. (2021).
Installation
Simply execute either
$ pip install neutralocean
if you use pip, or
$ conda install -c conda-forge neutralocean
if you use conda.
Documentation
Owner
- Name: Geoff Stanley
- Login: geoffstanley
- Kind: user
- Location: Victoria, Canada
- Company: University of Victoria
- Website: https://geoffstanley.github.io/
- Twitter: geoffjstanley
- Repositories: 2
- Profile: https://github.com/geoffstanley
I am a physical oceanographer, mostly of the theoretical and modelling variety.
Citation (CITATION.cff)
message: "If you use this software, please cite the paper below."
cff-version: 1.2.0
preferred-citation:
type: article
authors:
- family-names: "Stanley"
given-names: "Geoffrey J."
orcid: "https://orcid.org/0000-0003-4536-8602"
- family-names: "McDougall"
given-names: "Trevor J."
orcid: "https://orcid.org/0000-0003-4582-7741"
- family-names: "Barker"
given-names: "Paul M."
orcid: "https://orcid.org/0000-0001-6447-8538"
title: "Algorithmic improvements to finding approximately neutral surfaces"
journal: "Journal of Advances in Modeling Earth Systems"
doi: "10.1029/2020MS002436"
url: https://doi.org/10.1029/2020MS002436
volume: 13
start: e2020MS002436
year: 2021
GitHub Events
Total
- Issues event: 1
- Watch event: 4
- Delete event: 2
- Push event: 6
- Pull request event: 2
- Fork event: 2
- Create event: 1
Last Year
- Issues event: 1
- Watch event: 4
- Delete event: 2
- Push event: 6
- Pull request event: 2
- Fork event: 2
- Create event: 1
Committers
Last synced: about 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Geoff Stanley | g****y@g****m | 243 |
| Eric Firing | e****g@h****u | 18 |
| Navid C. Constantinou | n****y | 4 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 9 months ago
All Time
- Total issues: 2
- Total pull requests: 14
- Average time to close issues: 2 months
- Average time to close pull requests: about 23 hours
- Total issue authors: 2
- Total pull request authors: 4
- Average comments per issue: 3.0
- Average comments per pull request: 0.71
- Merged pull requests: 14
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 1
- Pull requests: 1
- Average time to close issues: 4 months
- Average time to close pull requests: 29 minutes
- Issue authors: 1
- Pull request authors: 1
- Average comments per issue: 5.0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 1
Top Authors
Issue Authors
- navidcy (1)
- geoffstanley (1)
Pull Request Authors
- geoffstanley (7)
- navidcy (3)
- efiring (3)
- dependabot[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 304 last-month
-
Total dependent packages: 1
(may contain duplicates) -
Total dependent repositories: 2
(may contain duplicates) - Total versions: 16
- Total maintainers: 1
pypi.org: neutralocean
Neutral Surfaces in the Ocean
- Homepage: https://github.com/geoffstanley/neutralocean
- Documentation: https://neutralocean.readthedocs.io/
- License: MIT
-
Latest release: 2.4.1
published 9 months ago
Rankings
Maintainers (1)
conda-forge.org: neutralocean
- Homepage: https://github.com/geoffstanley/neutralocean
- License: MIT
-
Latest release: 0.0.18
published over 3 years ago
Rankings
Dependencies
- Sphinx >=0.5.1,<6
- numpydoc ==1.5.0
- sphinx_rtd_theme *
- alabaster ==0.7.12
- babel ==2.10.3
- certifi ==2022.9.24
- charset-normalizer ==2.1.1
- docutils ==0.17.1
- idna ==3.4
- imagesize ==1.4.1
- jinja2 ==3.1.2
- markupsafe ==2.1.1
- numpydoc ==1.5.0
- packaging ==21.3
- pygments ==2.13.0
- pyparsing ==3.0.9
- pytz ==2022.5
- requests ==2.28.1
- snowballstemmer ==2.2.0
- sphinx ==5.3.0
- sphinx-rtd-theme ==1.0.0
- sphinxcontrib-applehelp ==1.0.2
- sphinxcontrib-devhelp ==1.0.2
- sphinxcontrib-htmlhelp ==2.0.0
- sphinxcontrib-jsmath ==1.0.1
- sphinxcontrib-qthelp ==1.0.3
- sphinxcontrib-serializinghtml ==1.1.5
- urllib3 ==1.26.12
- actions/checkout v3 composite
- actions/setup-python v3 composite
- gsw *
- numba *
- numpy *
- scipy *
- xarray *