Skip to main content

Package to generate computational unstructured meshes from planetary modeling.

Project description

lint workflow fnc workflow fnc2 workflow

OCSMesh

OCSMesh is a Python package for processing DEM data into georeferenced unstructured meshes using the jigsaw-python library.

Installation

Two ways of installing OCSMesh are described below:

Using conda

The recommended way to setup the environment for installing OCSMesh is to use conda with the environment.yml file provided in the repo to install required libraries.

The Jigsaw library and its Python wrapper must be instlled before OCSMesh can be used. Jigsaw is available on conda-forge channel.

First you need to download the environment.yml file.

wget https://raw.githubusercontent.com/noaa-ocs-modeling/OCSMesh/main/environment.yml

conda env create -f environment.yml -n your-env-name
conda activate your-env-name

conda install -y -c conda-forge jigsawpy
pip install ocsmesh

From GitHub repo

OCSMesh can be installed from the GitHub repository as well. After downloading the repo, you need to first install Jigsaw using the script provided in OCSMesh repo by calling: ./setup.py install_jigsaw in the OCSMesh root directory. Then OCSMesh can be installed.

git clone https://github.com/noaa-ocs-modeling/ocsmesh
cd ocsmesh
python ./setup.py install_jigsaw # To install latest Jigsaw from GitHub
python ./setup.py install # Installs the OCSMesh library to the current Python environment
# OR
python ./setup.py develop # Run this if you are a developer.

Requirements

  • 3.7 <= Python < 3.10
  • CMake
  • C/C++ compilers

How to Cite

Title : OCSMesh: a data-driven automated unstructured mesh generation software for coastal ocean modeling

Personal Author(s) : Mani, Soroosh;Calzada, Jaime R.;Moghimi, Saeed;Zhang, Y. Joseph;Myers, Edward;Pe’eri, Shachak;

Corporate Authors(s) : Coast Survey Development Laboratory (U.S.)

Published Date : 2021

Series : NOAA Technical Memorandum NOS CS ; 47

DOI : https://doi.org/10.25923/csba-m072

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ocsmesh-1.2.0.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

ocsmesh-1.2.0-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

Details for the file ocsmesh-1.2.0.tar.gz.

File metadata

  • Download URL: ocsmesh-1.2.0.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for ocsmesh-1.2.0.tar.gz
Algorithm Hash digest
SHA256 d25c231e68663243c6ec7c1864a0035b76e0d352b58415ac5cf04738d5c3b28f
MD5 68858937c1edf63d9f0a00948b330e32
BLAKE2b-256 0002f92a2661d34d06761bc2a07418e2fb6c50785a155b1fa2edcea60771346e

See more details on using hashes here.

File details

Details for the file ocsmesh-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: ocsmesh-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for ocsmesh-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3208f6496cad4c42388ffba56a20b1c225a2c3ea9143f98c85f5369b389d5b79
MD5 6724ab5a2e1df84a686394789c1f7bbe
BLAKE2b-256 b78ce34b217a97b9001395d7987fa7df9cbe5e56744b4917dd7056d5f501d0b5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page