Data

Tools

Indexes

Applications

Experiments

Open Source Science

pyschism

Python interface for handling the SCHISM model.

https://github.com/schism-dev/pyschism

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: zenodo.org
  • ✓
    Committers with academic emails
    5 of 11 committers (45.5%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (18.4%) to scientific vocabulary

Keywords

hydrodynamic-modeling python python-interface schism-model
Last synced: 6 months ago · JSON representation ·

Repository

Python interface for handling the SCHISM model.

Basic Info
Statistics
  • Stars: 33
  • Watchers: 15
  • Forks: 28
  • Open Issues: 43
  • Releases: 27
Topics
hydrodynamic-modeling python python-interface schism-model
Created about 6 years ago · Last pushed 8 months ago
Metadata Files
Readme Contributing License Citation

README.md

PySCHISM

codecov DOI

A Python interface for SCHISM model runs.

Installation:

Pre-requisites

It is highly recommended that you run this software using a Python virtual environment, and that you use Python>=3.6 (preferrably, using the latest available Python version is encouraged). You may use conda or venv to satisfy this dependency. You should also have the cdunits library installed. In ubuntu systems this is achieved by: bash apt-get install udunits-bin

Install option 1: pip

bash pip install pyschism

Install option 2: clone repo

To install, clone this repository, and navigate into it: bash git clone https://github.com/schism-dev/pyschism cd pyschism Then make sure to activate the target Python environment (this step is not necessary if you chose not to use a virtual environment). After making sure your target environment is active, you can install the package using pip:

bash pip install .

If you are a developer

If you are a developer, it is recommended that you clone the repo. After you add the -e flag to the pip install command in order to install in developer mode.

```bash pip install -e .

```

Usage examples:

Using the Library

Example 1: Full domain Hgrid plot:

python from pyschism.mesh import Hgrid hgrid = Hgrid.open('hgrid.gr3') hgrid.make_plot(show=True)

Example 2: Write mesh to QGIS friendly format

```python

NOTE: 2dm files can be read by QGIS > 3.0

from pyschism.mesh import Hgrid hgrid = Hgrid.open('hgrid.gr3') hgrid.write("/path/to/output/file.2dm", format='2dm')

```

Online manual

https://schism-dev.github.io/schism/master/getting-started/pre-processing-with-pyschism/overview.html

References

If you used this software as part of your work, please use the following citation format.

Jaime R Calzada, Linlin Cui, & Joseph Zhang. (2023). schism-dev/pyschism: v0.1.5 (v0.1.5). Zenodo. https://doi.org/10.5281/zenodo.7623122

Questions, comments and suggestions are welcome. Please follow the instructions on the CONTRIBUTING.md file for contributions. For bug reports and feature requests, please open an issue using the issue tracker. Main author name: Jaime R Calzada Author contact: jrcalzada@vims.edu

“Marconi is a good fellow. Let him continue. He is using seventeen of my patents.”
Nikola Tesla

Owner

  • Name: SCHISM Development
  • Login: schism-dev
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you used this software as part of your work, please use the following citation format."
authors:
  - family-names: Calzada
    given-names: Jaime R
    orcid: https://orcid.org/0000-0002-3172-1906
  - family-names: Cui
    given-names: Linlin
  - family-names: Zhang
    given-names: Joseph
title: "PySCHISM"
version: v0.1.5
doi: 10.5281/zenodo.7623122
date-released: 2023-02-08

GitHub Events

Total
  • Issues event: 21
  • Watch event: 8
  • Delete event: 1
  • Issue comment event: 77
  • Push event: 14
  • Pull request review event: 2
  • Pull request event: 10
  • Fork event: 5
  • Create event: 1
Last Year
  • Issues event: 21
  • Watch event: 8
  • Delete event: 1
  • Issue comment event: 77
  • Push event: 14
  • Pull request review event: 2
  • Pull request event: 10
  • Fork event: 5
  • Create event: 1

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 563
  • Total Committers: 11
  • Avg Commits per committer: 51.182
  • Development Distribution Score (DDS): 0.433
Past Year
  • Commits: 72
  • Committers: 5
  • Avg Commits per committer: 14.4
  • Development Distribution Score (DDS): 0.25
Top Committers
Name Email Commits
Jaime R Calzada j****l@g****m 319
cuill c****l@g****m 204
SorooshMani-NOAA s****i@n****v 18
Soroosh.Mani S****i@n****v 10
zachary.burnett z****t@n****v 4
Christelle s****3@g****m 3
Carsten Lemmen c****n@h****e 1
Linlin Cui l****1@f****u 1
TrellixVulnTeam c****d@t****m 1
Zach Burnett z****t@s****u 1
Panos Mavrogiorgos p****9@g****m 1
Committer Domains (Top 20 + Academic)
noaa.gov: 3 stsci.edu: 1 trellix.com: 1 femto.sciclone.wm.edu: 1 hzg.de: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 86
  • Total pull requests: 77
  • Average time to close issues: 26 days
  • Average time to close pull requests: 9 days
  • Total issue authors: 30
  • Total pull request authors: 17
  • Average comments per issue: 4.16
  • Average comments per pull request: 0.88
  • Merged pull requests: 56
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 18
  • Pull requests: 13
  • Average time to close issues: 3 months
  • Average time to close pull requests: 23 days
  • Issue authors: 10
  • Pull request authors: 5
  • Average comments per issue: 3.33
  • Average comments per pull request: 1.77
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 1
View more stats
Top Authors
Issue Authors
  • SorooshMani-NOAA (34)
  • feiye-vims (6)
  • BahramKhazaei-NOAA (5)
  • cuill (4)
  • dkobashi (4)
  • mansurjisan (2)
  • ghost (2)
  • pierrechabert (2)
  • saeed-moghimi-noaa (2)
  • hb-9797 (2)
  • uturuncoglu (2)
  • Adarshvb000 (1)
  • VHernaman (1)
  • lj-cug (1)
  • jreniel (1)
Pull Request Authors
  • cuill (19)
  • jreniel (18)
  • SorooshMani-NOAA (15)
  • felicio93 (10)
  • drf5n (2)
  • jduckerOWP (2)
  • dependabot[bot] (2)
  • mansurjisan (2)
  • tomdurrant (2)
  • cdibble (2)
  • wjcrawford (2)
  • platipodium (1)
  • pmav99 (1)
  • TrellixVulnTeam (1)
  • huyquangtranaus (1)
Top Labels
Issue Labels
bug (3) enhancement (2)
Pull Request Labels
dependencies (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 150 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 25
  • Total maintainers: 1
pypi.org: pyschism

Python package for working with SCHISM input and output files.

  • Versions: 25
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 150 Last month
Rankings
Dependent packages count: 3.3%
Forks count: 10.2%
Average: 14.0%
Stargazers count: 14.5%
Downloads: 19.6%
Dependent repos count: 22.2%
Maintainers (1)
jreniel
Last synced: 6 months ago

Dependencies

.github/workflows/release.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/download-artifact v2 composite
  • actions/setup-python v2 composite
  • actions/upload-artifact v2 composite
  • pypa/gh-action-pypi-publish v1.5.0 composite
docker/docker-compose.yml docker
  • schismdev/pyschism-arch-unittest latest
  • schismdev/pyschism-unittest latest
setup.py pypi
  • boto3 *
  • cdsapi *
  • cf-python *
  • cfgrib *
  • dask_geopandas *
  • f90nml *
  • fsspec *
  • geopandas *
  • metpy *
  • netCDF4 *
  • netcdf-flattener >=1.2.0
  • numba *
  • psutil *
  • pygeos *
  • pyugrid *
  • rtree *
  • scipy *
  • seawater *
  • sqlalchemy *
  • stormevents *
  • tqdm *
  • tqdm-logging-wrapper *
  • utm *
  • wget *
  • xarray *
  • xmltodict *
  • zarr *