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.10 <= Python
  • 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.6.1.tar.gz (30.0 MB view details)

Uploaded Source

Built Distribution

ocsmesh-1.6.1-py3-none-any.whl (30.2 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ocsmesh-1.6.1.tar.gz
  • Upload date:
  • Size: 30.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for ocsmesh-1.6.1.tar.gz
Algorithm Hash digest
SHA256 f41076e2c0ed16c18593320dc5ca48907ede81709f91b7f9824677e6e35c635b
MD5 ccdcf4cb54a454791bea77710c82b1b8
BLAKE2b-256 761d0c83c6cc1b061d59bebadf2b0f86d9d0b79f97ef0cc8c94fd50087dad50d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ocsmesh-1.6.1-py3-none-any.whl
  • Upload date:
  • Size: 30.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for ocsmesh-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a4ee87a7f4086ae772e34d346563dec0dcbeb8edf731e703373e765e6f329624
MD5 93620b110b12d6357e5e82df94a09ac8
BLAKE2b-256 291993b15b67d9d49acb369a002a4da8d12a45ed9e03bbc5a530cb1fc4efcc67

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