NIMPHS

NIMPHS: Numerous Instruments to Manipulate and Post-process Hydraulic Simulations - Published in JOSS (2023)

https://github.com/artelia/nimphs

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    1 of 6 committers (16.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

blender blender-addon computational-fluid-dynamics geophysical-fluid-dynamics openfoam post-processing telemac-mascaret
Last synced: 6 months ago · JSON representation

Repository

Blender add-on. Numerous Instruments to Manipulate and Post-process Hydraulic Simulations (OpenFOAM, TELEMAC).

Basic Info
Statistics
  • Stars: 16
  • Watchers: 3
  • Forks: 2
  • Open Issues: 2
  • Releases: 4
Topics
blender blender-addon computational-fluid-dynamics geophysical-fluid-dynamics openfoam post-processing telemac-mascaret
Created over 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing Code of conduct

README.md

NIMPHS

Numerous Instruments to Manipulate and Post-process Hydraulic Simulations.

Short description

Import OpenFOAM (.foam) and TELEMAC (.slf) files in Blender, and make use of its powerful 3D renderers to generate images and animations!

Documentation

Installation guide and documentation can be found here: NIMPHS documentation

Features overview

OpenFOAM

  • Preview the imported file in the viewport
  • Create sequences to render animations
    • Mesh sequence (generates a mesh for each time point in the selected time range)
    • Streaming sequence (generates a mesh when the frame changes and only keeps one mesh in memory)
  • Import point data as vertex colors (color attributes)
  • Clip mesh by a scalar

Screenshots

Wireframe preview | Material preview :------------------------------------:|:-----------------------------------: Wireframe | Material

TELEMAC

  • Works with 2D and 3D files
  • Preview the imported file in the viewport
  • Create sequences to render animations
    • Mesh sequence (generates a mesh for each time point in the selected time range)
    • Streaming sequence (generates a mesh when the frame changes and only keeps one mesh in memory)
  • Import point data as vertex colors (color attributes)
  • Linearly interpolate mesh and vertex colors (for both type of sequences) to render smoother animations
  • Extract point data from one vertex as time series
  • Generate volumes from TELEMAC-3D simulations

Screenshots

Wireframe preview | Material preview :------------------------------------:|:-----------------------------------: Wireframe | Material

Gallery

Here are some creations made with NIMPHS.

OpenFOAM

Model A | Model B :---------------------------------------------------:|:---------------------------------------------------: OpenFOAM gallery, model A | OpenFOAM gallery, model B

Model C | Model D :---------------------------------------------------:|:------------------------------: OpenFOAM gallery, model C | None

TELEMAC

Model A | Model B :---------------------------------------------------:|:---------------------------------------------------: OpenFOAM gallery, model A | OpenFOAM gallery, model B

Contributing

Contributor Covenant v2.1

We welcome contributions and hope that our contributing guide will help you to start easily.Make sure to read the code of conduct before contributing.

Citing NIMPHS

There is a paper about NIMPHS!

If you are using NIMPHS in your research, please cite our work.

Olart et al., (2023). NIMPHS: Numerous Instruments to Manipulate and Post-process Hydraulic Simulations. Journal of Open Source Software, 8(83), 4868, https://doi.org/10.21105/joss.04868

Bibtex

@article{Olart2023, doi = {10.21105/joss.04868}, url = {https://doi.org/10.21105/joss.04868}, year = {2023}, publisher = {The Open Journal}, volume = {8}, number = {83}, pages = {4868}, author = {Félix Olart and Thibault Oudart and Olivier Bertrand and Mehdi-Pierre Daou}, title = {NIMPHS: Numerous Instruments to Manipulate and Post-process Hydraulic Simulations}, journal = {Journal of Open Source Software} }

Owner

  • Name: ARTELIA
  • Login: Artelia
  • Kind: organization

JOSS Publication

NIMPHS: Numerous Instruments to Manipulate and Post-process Hydraulic Simulations
Published
March 13, 2023
Volume 8, Issue 83, Page 4868
Authors
Félix Olart
ARTELIA, France, Université Gustave Eiffel, France
Thibault Oudart
ARTELIA, France
Olivier Bertrand
ARTELIA, France
Mehdi-Pierre Daou
ARTELIA, France
Editor
Hugo Ledoux ORCID
Tags
OpenFOAM TELEMAC-MASCARET Computational fluid dynamics Geophysical fluid dynamics Blender

GitHub Events

Total
  • Watch event: 3
Last Year
  • Watch event: 3

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 539
  • Total Committers: 6
  • Avg Commits per committer: 89.833
  • Development Distribution Score (DDS): 0.132
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Félix f****t@a****m 468
Félix f****6@g****m 66
Hugo Ledoux h****x@t****l 2
daoum d****m 1
OUDART Thibault t****t@a****m 1
OLART Felix f****t@a****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 9
  • Total pull requests: 11
  • Average time to close issues: about 1 month
  • Average time to close pull requests: about 22 hours
  • Total issue authors: 3
  • Total pull request authors: 2
  • Average comments per issue: 0.89
  • Average comments per pull request: 0.18
  • Merged pull requests: 11
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Failxxx (7)
  • liberostelios (1)
  • bnase (1)
Pull Request Authors
  • Failxxx (9)
  • hugoledoux (2)
Top Labels
Issue Labels
bug (4) enhancement (2) documentation (1)
Pull Request Labels
documentation (2) enhancement (2) bug (1)

Dependencies

nimphs/requirements.txt pypi
  • matplotlib *
  • pyvista >=0.35.1
requirements.txt pypi
  • blender-addon-tester *
  • fake-bpy-module-latest *
  • matplotlib *
  • myst-parser *
  • numba *
  • pre-commit *
  • pyenchant *
  • pytest *
  • pyvista >=0.35.1
  • sphinx *
  • sphinx-rtd-theme *
  • sphinxcontrib-spelling *
  • sphinxcontrib-video *
  • sphinxemoji *
scripts/requirements.txt pypi
  • blender-addon-tester *
  • matplotlib *
  • pytest *
  • pyvista >=0.35.0
.github/workflows/docs.yml actions
  • actions/cache v3.0.4 composite
  • actions/checkout v2.4.2 composite
  • actions/download-artifact v3.0.0 composite
  • actions/setup-python v4.0.0 composite
  • actions/upload-artifact v3.1.0 composite
  • peaceiris/actions-gh-pages v3.7.3 composite
  • syphar/restore-virtualenv v1.2 composite
.github/workflows/style.yml actions
  • actions/checkout v2.4.2 composite
  • actions/setup-python v4.0.0 composite
.github/workflows/unit-testing.yml actions
  • actions/cache v3.0.4 composite
  • actions/checkout v2.4.2 composite
  • actions/setup-python v4.0.0 composite
  • syphar/restore-virtualenv v1.2 composite