Science Score: 46.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
-
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
3 of 9 committers (33.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.9%) to scientific vocabulary
Keywords from Contributors
Repository
Work with ROMS ocean model output with xarray
Basic Info
- Host: GitHub
- Owner: xoceanmodel
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://xroms.readthedocs.io/
- Size: 55.5 MB
Statistics
- Stars: 68
- Watchers: 5
- Forks: 41
- Open Issues: 12
- Releases: 26
Metadata Files
README.md
xroms
xroms contains functions for commonly used scripts for working with ROMS output in xarray.
There are functions to...
* help read in model output with automatically-calculated z coordinates
* calculate many derived variables with correct grid metrics in one line including:
* horizontal speed
* kinetic energy
* eddy kinetic energy
* vertical shear
* vertical vorticity
* horizontal divergence
* normalized surface divergence
* Ertel potential vorticity
* density as calculated in ROMS
* potential density
* buoyancy
* $N^2$ (buoyancy frequency/vertical buoyancy gradient)
* $M^2$ (horizontal buoyancy gradient)
* useful functions including:
* derivatives in all dimensions, accounting for curvilinear grids and sigma layers
* grid metrics (i.e., grid lengths, areas, and volumes)
* subset horizontal grid such that the staggered grids are consistent
* easily change horizontal and vertical grids using xgcm grid objects
* easily reorder to dimensional convention
* slice along a fixed value
* wrapper for interpolation in longitude/latitude and for fixed depths
* mixed-layer depth
* Demonstrations:
* selecting data in many different ways
* interpolation
* changing time sampling
* calculating climatologies
* various calculations
* provide/track attributes and coordinates through functions
* wraps cf-xarray to generalize coordinate and dimension calling.
* ability to automatically choose colormaps for plotting with xarray
* wraps xcmocean for this
Installation
You need to have conda installed for these installation instructions. You'll have best results if you use the channel conda-forge, which you can prioritize with conda config --add channels conda-forge --force.
Install, the easy way
PyPI:
pip install xroms
conda-forge:
mamba install -c conda-forge xroms
Create environment if needed
As a first step, you can create an environment for this package with conda if you want. If you do this, you'll need to git clone the package first as below. Note that mamba and conda can be used interchangeably, but mamba is faster for installation.
mamba env create -f environment.yml
You can choose to install with conda the optional dependencies for full functionality:
conda install --file requirements-opt.txt
and to install optional dependency xcmocean:
pip install git+https://github.com/pangeo-data/xcmocean
Then choose one of the following to install xroms from GitHub:
Clone
xromsinto a particular directory then install so that it is editable (-e)git clone https://github.com/xoceanmodel/xroms.git cd xroms pip install -e .Directly install
xromsfrom githubpip install git+https://github.com/xoceanmodel/xroms
Owner
- Name: xoceanmodel
- Login: xoceanmodel
- Kind: organization
- Repositories: 1
- Profile: https://github.com/xoceanmodel
GitHub Events
Total
- Create event: 4
- Issues event: 4
- Release event: 2
- Watch event: 12
- Delete event: 2
- Issue comment event: 3
- Push event: 4
- Pull request event: 10
- Fork event: 3
Last Year
- Create event: 4
- Issues event: 4
- Release event: 2
- Watch event: 12
- Delete event: 2
- Issue comment event: 3
- Push event: 4
- Pull request event: 10
- Fork event: 3
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Kristen Thyng | k****g@g****m | 209 |
| hetland | h****d@t****u | 15 |
| dependabot[bot] | 4****] | 12 |
| Filipe Fernandes | o****f@g****m | 3 |
| Christoph Renkl | c****l@d****a | 2 |
| rsignell | 1****l | 1 |
| Veronica Ruiz Xomchuk | v****x@t****u | 1 |
| Navid C. Constantinou | n****y | 1 |
| Mike Smith | m****m@m****u | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 24
- Total pull requests: 54
- Average time to close issues: 6 months
- Average time to close pull requests: 29 days
- Total issue authors: 19
- Total pull request authors: 9
- Average comments per issue: 2.5
- Average comments per pull request: 0.67
- Merged pull requests: 47
- Bot issues: 0
- Bot pull requests: 12
Past Year
- Issues: 4
- Pull requests: 6
- Average time to close issues: N/A
- Average time to close pull requests: 2 days
- Issue authors: 4
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.5
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 2
Top Authors
Issue Authors
- bjornaa (3)
- hetland (2)
- kyle-hinson (2)
- tlsw231 (2)
- imcslatte (2)
- ak11283 (1)
- claudiofgcardoso (1)
- jaard (1)
- nmalan (1)
- dylanschlichting (1)
- CaiqueDiasLuko (1)
- jl2158 (1)
- dcherian (1)
- JeremyCollin (1)
- Sumanshekhar17 (1)
Pull Request Authors
- kthyng (35)
- dependabot[bot] (15)
- najascutellatus (2)
- rsignell (2)
- vrx- (2)
- navidcy (2)
- ocefpaf (1)
- christophrenkl (1)
- dylanschlichting (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 602 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 50
- Total maintainers: 1
proxy.golang.org: github.com/xoceanmodel/xroms
- Documentation: https://pkg.go.dev/github.com/xoceanmodel/xroms#section-documentation
- License: mit
-
Latest release: v0.6.2
published 7 months ago
Rankings
pypi.org: xroms
Package for working with ROMS output in xarray
- Homepage: https://github.com/xoceanmodel/xroms
- Documentation: https://xroms.readthedocs.io/
- License: MIT
-
Latest release: 0.6.2
published 7 months ago
Rankings
Maintainers (1)
Dependencies
- black * development
- check-manifest * development
- doctr * development
- flake8 * development
- flake8-builtins * development
- flake8-comprehensions * development
- flake8-mutable * development
- flake8-print * development
- isort * development
- mypy * development
- nbsphinx * development
- pre-commit * development
- pylint * development
- pytest * development
- pytest-cov * development
- pytest-xdist * development
- setuptools_scm * development
- sphinx * development
- twine * development
- wheel * development
- zarr * development
- cartopy >=0.18
- cmocean *
- datashader >=0.11
- geoviews *
- holoviews *
- hvplot *
- matplotlib *
- zarr *
- cf_xarray *
- dask *
- jupyter *
- jupyterlab *
- netcdf4 *
- numba >=0.49
- numpy *
- xarray *
- xgcm *
- actions/cache v3 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- pre-commit/action v3.0.0 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- pypa/gh-action-pypi-publish master composite
- actions/cache v3 composite
- actions/checkout v3 composite
- codecov/codecov-action v3 composite
- conda-incubator/setup-miniconda v2 composite
- docrep <=0.2.7
- jupyter_client *
- nbsphinx >=0.8.7
- sphinx-copybutton *
- sphinx_pangeo_theme *
- sphinxcontrib-srclinks *