Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.5%) to scientific vocabulary
Keywords
Repository
WIP Prototype of a modern CFD core
Basic Info
Statistics
- Stars: 74
- Watchers: 7
- Forks: 13
- Open Issues: 46
- Releases: 1
Topics
Metadata Files
README.md
Requirements | Compilation | Integration | Documentation | Roadmap |
NeoN
[!IMPORTANT] The NeoN project needs you! If you're interested in contributing to NeoN please open a PR! If you have any questions on where to start please contact us here or on gitter.
Requirements
NeoN has the following requirements
- cmake > 3.22
- gcc >= 10 or clang >= 16
- Kokkos 4.3.0
For NVIDIA GPU support * cuda 12+
For development it is required to use pre-commit.
C++ dependencies
C++ dependencies like Kokkos are handled via CPM and are cloned at the configuration step.
However, the cmake build process will prefer system wide installed C++ dependencies like Kokkos, cxxopts, etc.
If you prefer to clone, configure and build dependencies your self consider setting -DCPM_USE_LOCAL_PACKAGES = OFF, see CPM for more details.
Compilation
NeoN uses cmake to build, thus the standard cmake procedure should work. From a build directory you can execute
cmake <DesiredBuildFlags> ..
cmake --build .
cmake --install .
Additionally, we provide several Cmake presets to set commmonly required flags if you compile NeoN in combination with Kokkos.
cmake --list-presets # To list existing presets
cmake --preset production # To configure for production use
cmake --build --preset production # To compile for production use
Executing Tests
We provide a set of unit tests which can be executed via ctest or
cmake --build . --target test
Integration with other CFD Frameworks
Currently, NeoN is not a standalone CFD framework. It is designed to be used with other CFD Frameworks. Examples how to integrate NeoN into CFD frameworks and how to write applications is demonstrated in the FoamAdapter repository.
Documentation
An online documentation can be found here, be cautious since this repository is currently evolving the documentation might not always reflect the latest stage. For building the documentation further dependencies like doxygen and sphinx are requirement. The list of requirements can be found here
Owner
- Name: exasim-project
- Login: exasim-project
- Kind: organization
- Repositories: 6
- Profile: https://github.com/exasim-project
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." abstract: '<p>The NeoN team is proud to announce the first release of NeoN, a next generation implementation of a CFD core. NeoN leverages the features of modern C++ to implement core routines to efficiently solve PDEs required by CFD frameworks like OpenFOAM, thus NeoN helps to catch up with the rapidly evolving HPC ecosystem.</p> <p>Our design goals are:</p> <ul> <li>Platform portable for all CPU and GPU hardware vendors</li> <li>Modular design leveraging the existing simulation software ecosystem like Kokkos, sundials, PETSc, or Ginkgo</li> <li>Implement an updated domain specific language for DSL that allows to encode complex partial differential equations in a concise yet powerful form</li> <li>Simple adoption within OpenFOAM</li> <li>Target multiphysics simulations and enable simple integration of coupling software like preCICE</li> </ul> <p>This v.0.1 release is all about building a foundation for the future developments of NeoN. It focuses on building the foundational library structure, a first draft of the DSL API including basic kernels, and a solid CI/CD infrastructure from the start. It features unit and integration testing on Linux, macOS, and Windows as well as sanitizer and static analyzer <a href="https://github.com/exasim-project/NeoN/actions">workflows</a>.</p> <p>Integration into OpenFOAM applications are demonstrated in our <a href="https://github.com/exasim-project/FoamAdapter">FoamAdapter</a> repository. A full list of changes can be found in the <a href="https://github.com/exasim-project/NeoN/blob/main/CHANGELOG.md">CHANGELOG.md</a>. An exciting year is ahead of us, visit our <a href="https://github.com/orgs/exasim-project/projects/1/views/8">Roadmap</a> to find out which features are next. Thank you to everyone who <a href="https://github.com/exasim-project/NeoN/blob/main/AUTHORS.md">contributed</a> to NeoN.</p>' authors: - affiliation: Scientific Computing Centre, KIT family-names: Gregor Olenik orcid: 0000-0002-0128-3933 - family-names: Henning Scheufler - family-names: Bevan Jones - affiliation: Harbin Engineering University family-names: Feiteng Meng - affiliation: Karlsruhe Institute of Technology family-names: Marcel Koch orcid: 0009-0004-8333-9313 - affiliation: "TU M\xFCnchen" family-names: Chih-Ta Wang - affiliation: "TU M\xFCnchen" family-names: Roman Mishchuk - affiliation: '@microfluidica' family-names: Gabriel Gerlero - affiliation: High-Performance Computing Center Stuttgart (HLRS) family-names: Gregor Weiss orcid: 0000-0002-2132-670X - family-names: Hendrik Hetmann cff-version: 1.2.0 date-released: '2025-01-07' doi: 10.5281/zenodo.14608521 identifiers: - type: swh value: swh:1:dir:23b093ca93f7cb70a6f69e2ace9d1f5b544c74fd;origin=https://doi.org/10.5281/zenodo.14608520;visit=swh:1:snp:73cda13210a8cae3a1e01e8600fa60c1d947172c;anchor=swh:1:rel:b5d17f5f6e4e99f5c39e87485e511a7a2427d5ad;path=exasim-project-NeoN-2954c3b keywords: - CFD - GPU license: - cc-by-4.0 repository-code: https://github.com/hpsim/OGL title: 'NeoN: a modern CFD core' type: software version: v0.1.0
GitHub Events
Total
- Issues event: 11
- Watch event: 5
- Delete event: 111
- Issue comment event: 61
- Push event: 453
- Pull request review comment event: 28
- Pull request review event: 36
- Pull request event: 66
- Fork event: 3
- Create event: 37
Last Year
- Issues event: 11
- Watch event: 5
- Delete event: 111
- Issue comment event: 61
- Push event: 453
- Pull request review comment event: 28
- Pull request review event: 36
- Pull request event: 66
- Fork event: 3
- Create event: 37
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 5
- Total pull requests: 129
- Average time to close issues: 7 days
- Average time to close pull requests: 15 days
- Total issue authors: 3
- Total pull request authors: 10
- Average comments per issue: 0.2
- Average comments per pull request: 1.46
- Merged pull requests: 102
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 5
- Pull requests: 103
- Average time to close issues: 7 days
- Average time to close pull requests: 14 days
- Issue authors: 3
- Pull request authors: 10
- Average comments per issue: 0.2
- Average comments per pull request: 1.57
- Merged pull requests: 83
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- bevanwsjones (3)
- HenningScheufler (1)
- isoAdvector (1)
Pull Request Authors
- greole (72)
- HenningScheufler (26)
- bevanwsjones (9)
- happyKitesurfer (7)
- MarcelKoch (7)
- chihtaw (3)
- HendriceH (2)
- yhmtsai (1)
- Fitanium (1)
- gregorweiss (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 0
- Total maintainers: 2
spack.io: neon
NeoN is a PDE solver for CFD frameworks.
- Homepage: https://github.com/exasim-project/neon
- License: []