Data

Tools

Indexes

Applications

Experiments

Open Source Science

emsarray

xarray extension that supports EMS model formats

https://github.com/csiro-coasts/emsarray

Science Score: 62.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
  • ✓
    Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • ✓
    Institutional organization owner
    Organization csiro-coasts has institutional domain (research.csiro.au)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

xarray extension that supports EMS model formats

Basic Info
  • Host: GitHub
  • Owner: csiro-coasts
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Size: 1.43 MB
Statistics
  • Stars: 13
  • Watchers: 3
  • Forks: 3
  • Open Issues: 14
  • Releases: 12
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

emsarray

Binder Documentation Status Conda Version

The emsarray package provides a common interface for working with the many model geometry conventions used at CSIRO. It enhances xarray Datasets and provides a set of common operations for manipulating datasets.

To use, open the dataset using the emsarray.open_dataset() function and use the dataset.ems attribute:

```python import emsarray from shapely.geometry import Point

dataset = emsarray.tutorial.opendataset('gbr4') capricorngroup = Point(151.869, -23.386) pointdata = dataset.ems.selectpoint(capricorn_group) ```

Some methods take a DataArray as a parameter:

```python

Plot the sea surface temperature for time = 0

temp = dataset['temp'].isel(time=0, k=-1) dataset.ems.plot(temp) ```

Plot of sea surface temperature from the GBR4 example file

A number of operations provide further functionality to manipulate datasets, export geometry, and select subsets of data:

python from emsarray.operations import geometry geometry.write_geojson(dataset, './gbr4.geojson') geometry.write_shapefile(dataset, './gbr4.shp')

Links

Examples

Examples of using emsarray are available in the emsarray-notebooks repository. You can explore these notebooks online with Binder.

Developing

To get set up for development, make a virtual environment and install the dependencies:

shell $ python3 -m venv $ source venv/bin/activate $ pip install --upgrade pip>=21.3 $ pip install -e .[testing]

Tests

To run the tests, install and run tox:

shell $ python3 -m venv $ source venv/bin/activate $ pip install --upgrade pip>=21.3 tox $ tox

Documentation

The documentation for the current stable version of emsarray is available on Read The Docs.

To build the documentation, install the development requirements as above and invoke Sphinx:

shell $ make -C docs/ html

While updating or adding to the documentation, run the live target to automatically rebuild the docs whenever anything changes. This will serve the documentation via a livereload server.

shell $ make -C docs/ live

You can the view the docs at http://localhost:5500

Owner

  • Name: CSIRO Coastal Group
  • Login: csiro-coasts
  • Kind: organization
  • Email: cem@csiro.au
  • Location: Hobart, Tasmania, Australia

Specialising in providing environmental intelligence for decision support tools.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: emsarray
version: 0.9.0
date-released: 2025-01-23
type: software
authors:
  - given-names: Tim
    family-names: Heap
    email: tim.heap@csiro.au
    affiliation: Commonwealth Scientific and Industrial Research Organisation
  - given-names: Farhan
    family-names: Rizwi
    affiliation: Commonwealth Scientific and Industrial Research Organisation
    email: farhan.rizwi@csiro.au
references:
  - type: generic
    publisher:
      name: CSIRO
url: 'http://hdl.handle.net/102.100.100/482171?index=1'
license: BSD-3-Clause

GitHub Events

Total
  • Create event: 19
  • Issues event: 15
  • Release event: 2
  • Delete event: 17
  • Issue comment event: 20
  • Push event: 53
  • Pull request review event: 16
  • Pull request review comment event: 13
  • Pull request event: 28
  • Fork event: 1
Last Year
  • Create event: 19
  • Issues event: 15
  • Release event: 2
  • Delete event: 17
  • Issue comment event: 20
  • Push event: 53
  • Pull request review event: 16
  • Pull request review comment event: 13
  • Pull request event: 28
  • Fork event: 1

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 176
  • Total Committers: 1
  • Avg Commits per committer: 176.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 176
  • Committers: 1
  • Avg Commits per committer: 176.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Tim Heap t****p@c****u 176
Committer Domains (Top 20 + Academic)
csiro.au: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 47
  • Total pull requests: 153
  • Average time to close issues: 3 months
  • Average time to close pull requests: 6 days
  • Total issue authors: 8
  • Total pull request authors: 3
  • Average comments per issue: 0.91
  • Average comments per pull request: 0.2
  • Merged pull requests: 142
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 10
  • Pull requests: 18
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Issue authors: 3
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.67
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • mx-moth (34)
  • sharon-tickell (5)
  • david-sh-csiro (3)
  • blasee (1)
  • rtcsiro (1)
  • sspagnol (1)
  • frizwi (1)
  • emlynmjones (1)
Pull Request Authors
  • mx-moth (147)
  • david-sh-csiro (5)
  • Lachlan00 (1)
Top Labels
Issue Labels
enhancement (6) documentation (1) bug (1)
Pull Request Labels
bug (6) documentation (2)

Packages

  • Total packages: 3
  • Total downloads:
    • pypi 82 last-month
  • Total dependent packages: 2
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 23
  • Total maintainers: 2
pypi.org: emsarray

xarray extension that supports multiple geometry conventions

  • Documentation: https://emsarray.readthedocs.io/
  • License: Copyright 2023 Commonwealth Scientific and Industrial Research Organisation Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Latest release: 0.9.0
    published about 1 year ago
  • Versions: 15
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 82 Last month
Rankings
Dependent packages count: 3.3%
Downloads: 14.8%
Average: 16.2%
Stargazers count: 17.7%
Dependent repos count: 22.2%
Forks count: 22.8%
Maintainers (2)
tim_heap onaci-admin
Last synced: 6 months ago
conda-forge.org: emsarray-core
  • Versions: 4
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Dependent packages count: 28.8%
Dependent repos count: 34.0%
Average: 43.4%
Stargazers count: 53.5%
Forks count: 57.4%
Last synced: 6 months ago
conda-forge.org: emsarray
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Average: 49.0%
Dependent packages count: 51.2%
Stargazers count: 53.5%
Forks count: 57.4%
Last synced: 6 months ago

Dependencies

.github/actions/build-python-package/action.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
.github/actions/environment/action.yaml actions
  • actions/cache v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • conda-incubator/setup-miniconda v2 composite
.github/workflows/ci.yaml actions
  • ./.github/actions/build-python-package * composite
  • ./.github/actions/environment * composite
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • mikepenz/action-junit-report v3 composite
.github/workflows/release-tags.yaml actions
  • ./.github/actions/build-python-package * composite
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
continuous-integration/requirements.txt pypi
  • accessible-pygments ==0.0.4
  • alabaster ==0.7.13
  • babel ==2.12.1
  • beautifulsoup4 ==4.12.2
  • bokeh ==3.2.2
  • bottleneck ==1.3.7
  • cachetools ==5.3.1
  • cartopy ==0.22.0
  • certifi ==2023.7.22
  • cftime ==1.6.2
  • cfunits ==3.3.6
  • chardet ==5.2.0
  • charset-normalizer ==3.2.0
  • click ==8.1.7
  • cloudpickle ==2.2.1
  • colorama ==0.4.6
  • contourpy ==1.1.0
  • coverage ==7.3.0
  • cycler ==0.11.0
  • dask ==2023.8.1
  • distlib ==0.3.7
  • distributed ==2023.8.1
  • docutils ==0.19
  • exceptiongroup ==1.1.3
  • filelock ==3.12.2
  • flake8 ==6.1.0
  • fonttools ==4.42.1
  • fsspec ==2023.6.0
  • geojson ==3.0.1
  • idna ==3.4
  • imagesize ==1.4.1
  • importlib-metadata ==6.8.0
  • iniconfig ==2.0.0
  • isort ==5.12.0
  • jinja2 ==3.1.2
  • kiwisolver ==1.4.4
  • livereload ==2.6.3
  • locket ==1.0.0
  • lz4 ==4.3.2
  • markupsafe ==2.1.3
  • matplotlib ==3.7.2
  • mccabe ==0.7.0
  • msgpack ==1.0.5
  • mypy ==1.5.1
  • mypy-extensions ==1.0.0
  • netcdf4 ==1.6.4
  • numpy ==1.25.2
  • packaging ==23.1
  • pandas ==2.0.3
  • pandas-stubs ==2.0.3.230814
  • partd ==1.4.0
  • pillow ==10.0.0
  • platformdirs ==3.10.0
  • pluggy ==1.2.0
  • pooch ==1.7.0
  • psutil ==5.9.5
  • pyarrow ==13.0.0
  • pycodestyle ==2.11.0
  • pydata-sphinx-theme ==0.13.3
  • pyflakes ==3.1.0
  • pygments ==2.16.1
  • pykdtree ==1.3.7.post0
  • pyparsing ==3.0.9
  • pyproj ==3.6.0
  • pyproject-api ==1.5.4
  • pyshp ==2.3.1
  • pytest ==7.4.0
  • pytest-cov ==4.1.0
  • python-dateutil ==2.8.2
  • pytz ==2023.3
  • pyyaml ==6.0.1
  • requests ==2.31.0
  • shapely ==2.0.1
  • six ==1.16.0
  • snowballstemmer ==2.2.0
  • sortedcontainers ==2.4.0
  • soupsieve ==2.4.1
  • sphinx ==6.2.1
  • sphinx-book-theme ==1.0.1
  • sphinxcontrib-applehelp ==1.0.7
  • sphinxcontrib-devhelp ==1.0.5
  • sphinxcontrib-htmlhelp ==2.0.4
  • sphinxcontrib-jsmath ==1.0.1
  • sphinxcontrib-qthelp ==1.0.6
  • sphinxcontrib-serializinghtml ==1.1.9
  • tblib ==2.0.0
  • tomli ==2.0.1
  • toolz ==0.12.0
  • tornado ==6.3.3
  • tox ==4.10.0
  • types-pytz ==2023.3.0.1
  • typing-extensions ==4.7.1
  • tzdata ==2023.3
  • urllib3 ==2.0.4
  • virtualenv ==20.24.3
  • xarray ==2023.8.0
  • xyzservices ==2023.7.0
  • zict ==3.0.0
  • zipp ==3.16.2
pyproject.toml pypi
setup.py pypi
continuous-integration/environment.yaml conda
  • geos ~=3.10.2
  • udunits2 >=2.2.25