PySCHISM
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:
apt-get install udunits-bin
Install option 1: pip
pip install pyschism
Install option 2: clone repo
To install, clone this repository, and navigate into it:
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:
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.
pip install -e .
Usage examples:
Using the Library
Example 1: Full domain Hgrid plot:
from pyschism.mesh import Hgrid
hgrid = Hgrid.open('hgrid.gr3')
hgrid.make_plot(show=True)
Example 2: Write mesh to QGIS friendly format
# 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", fmt='2dm')
Online manual
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
1 maintainer
Release files for pyschism 0.1.15
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pyschism-0.1.15.tar.gz | 518.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyschism-0.1.15-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:745.2 kB
Release files / pyschism-0.1.15.tar.gz
| Download URL | pyschism-0.1.15.tar.gz |
|---|---|
| Size | 518.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
42bed698d21bd8e24427a8ffba9148f74519da02ec35e1e0e463feacb47d5bac
|
|
BLAKE2b-256 checksum How to use checksums |
1f7bae4aea93ad8c66e4fa213e1dfd20162a316744aff7237fe7cbd77a5329e6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
Release files / pyschism-0.1.15-py3-none-any.whl
| Download URL | pyschism-0.1.15-py3-none-any.whl |
|---|---|
| Size | 226.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b2db11cdb199d02fd8be24902a30dbda83c60147ce77a4f4e03161baf9b35644
|
|
BLAKE2b-256 checksum How to use checksums |
e3b2df0dcb888f3b4faab6fe72c4409e0c7cac8b62cb50b4808882508d811589
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
