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.5.9.tar.gz (30.0 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ocsmesh-1.5.9.tar.gz
Algorithm Hash digest
SHA256 eeff9c6f7c5f9ad1749f0b4ccf2c47a8bc52cc29d0dbedc67e35c53243808545
MD5 77d227ff5ee5fe5513b235837783ba19
BLAKE2b-256 b5bf4231076bb2e0fd370592790b6672a0bc8e270aae4273cfa4691cc910990a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ocsmesh-1.5.9-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.19

File hashes

Hashes for ocsmesh-1.5.9-py3-none-any.whl
Algorithm Hash digest
SHA256 a1d18f37d4cd93303f2c99904bf47f9dc7343d96d4183cf7746112d012a62042
MD5 92c50e2355b9a99a34d181ec9665f0e6
BLAKE2b-256 6382d20f12e00ecbc93613621b856755345c398e257fde434bf8019cc6bf64e4

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