{"id":18707906,"url":"https://github.com/ceed/nekrs","last_synced_at":"2025-04-12T10:31:48.636Z","repository":{"id":86733204,"uuid":"318603317","full_name":"CEED/NekRS","owner":"CEED","description":"Mirror of NekRS - GPU-oriented version of Nek5000. Please use the official repository, https://github.com/Nek5000/nekRS, to create issues and pull requests.","archived":false,"fork":false,"pushed_at":"2024-09-16T06:31:38.000Z","size":94744,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-09-16T10:07:01.960Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://nek5000.mcs.anl.gov/","language":"C++","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CEED.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-04T18:29:03.000Z","updated_at":"2023-10-06T00:33:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"56908e09-397e-4058-8a53-21bde5c6c4ad","html_url":"https://github.com/CEED/NekRS","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CEED%2FNekRS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CEED%2FNekRS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CEED%2FNekRS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CEED%2FNekRS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CEED","download_url":"https://codeload.github.com/CEED/NekRS/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223510946,"owners_count":17157441,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T12:20:16.953Z","updated_at":"2024-11-07T12:20:17.576Z","avatar_url":"https://github.com/CEED.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"```\n                 __    ____  _____\n   ____   ___   / /__ / __ \\/ ___/\n  / __ \\ / _ \\ / //_// /_/ /\\__ \\ \n / / / //  __// ,\u003c  / _, _/___/ / \n/_/ /_/ \\___//_/|_|/_/ |_|/____/  \nCOPYRIGHT (c) 2019-2023 UCHICAGO ARGONNE, LLC\n```\n\n[![Build Status](https://travis-ci.com/Nek5000/nekRS.svg?branch=master)](https://travis-ci.com/Nek5000/nekRS)\n[![License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://opensource.org/licenses/BSD-3-Clause)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7984525.svg)](https://doi.org/10.5281/zenodo.7984525)\n\n**nekRS** is a fast and scaleable computational fluid dynamics (CFD) solver targeting HPC applications. The code started as an early fork of [libParanumal](https://github.com/paranumal/libparanumal) in 2019.\n\nCapabilities:\n\n* Incompressible and low Mach-number Navier-Stokes + scalar transport \n* High-order curvilinear conformal spectral elements in space \n* Variable time step 2nd/3rd order semi-implicit time integration\n* MPI + [OCCA](https://github.com/libocca/occa) (backends: CUDA, HIP, OPENCL, SERIAL/C++)\n* LES and RANS turbulence models\n* Arbitrary-Lagrangian-Eulerian moving mesh\n* Lagrangian phase model\n* Overlapping overset grids\n* Conjugate fluid-solid heat transfer\n* Various boundary conditions\n* VisIt \u0026 Paraview support for data analysis and visualization\n* Legacy interface to [Nek5000](https://github.com/Nek5000/Nek5000) \n\n## Build Instructions\n\nRequirements:\n* Linux, Mac OS X (Microsoft WSL and Windows is not supported) \n* C++17/C99 compatible compiler\n* GNU/Intel/NVHPC Fortran compiler\n* MPI-3.1 or later\n* CMake version 3.18 or later \n\nDownload the latest release available under\n\n```sh\nhttps://github.com/Nek5000/nekRS/archive/refs/tags/v23.0.tar.gz \n```\n\nor clone our GitHub repository:\n\n```sh\nhttps://github.com/Nek5000/nekRS.git\n```\nThe `master` branch always points to the latest stable release while `next`\nprovides an early preview of the next upcoming release (do not use in a production environment).\n\n#\nTo build and install the code run:\n\n```sh\nCC=mpicc CXX=mpic++ FC=mpif77 ./nrsconfig [-DCMAKE_INSTALL_PREFIX=$HOME/.local/nekrs]\n```\nBuild settings can be customized through CMake options passed to `nrsconfig`. \nPlease remove the previous build and installation directory in case of an update. \n\n## Setting the Enviroment\n\nAssuming you run `bash` and your install directory is $HOME/.local/nekrs, \nadd the following line to your $HOME/.bash_profile:\n\n```sh\nexport NEKRS_HOME=$HOME/.local/nekrs\nexport PATH=$NEKRS_HOME/bin:$PATH\n```\nthen type `source $HOME/.bash_profile` in the current terminal window. \n\n## Run the Code\n\nWe try hard not to break userland but the code is evolving quickly so things might change from one version to another without being backward compatible. Please consult `RELEASE.md` *before* using the code. \n\n```sh\ncd $NEKRS_HOME/examples/turbPipePeriodic\nmpirun -np 2 nekrs --setup turbPipe.par\n```\nFor convenience we provide various launch scripts in the `bin` directory.\n\n## Documentation \nFor documentation, see our [readthedocs page](https://nekrs.readthedocs.io/en/latest/). For now it's just a dummy. We hope to improve it soon. \n\n## Discussion Group\nPlease visit [GitHub Discussions](https://github.com/Nek5000/nekRS/discussions). Here we help, find solutions, share ideas, and follow discussions.\n\n## Contributing\nOur project is hosted on [GitHub](https://github.com/Nek5000/nekRS). To learn how to contribute, see `CONTRIBUTING.md`.\n\n## Reporting Bugs\nAll bugs are reported and tracked through [Issues](https://github.com/Nek5000/nekRS/issues). If you are having trouble installing the code or getting your case to run properly, you should first vist our discussion group.\n\n## License\nnekRS is released under the BSD 3-clause license (see `LICENSE` file). \nAll new contributions must be made under the BSD 3-clause license.\n\n## Citing nekRS\n[NekRS, a GPU-Accelerated Spectral Element Navier-Stokes Solver](https://www.sciencedirect.com/science/article/abs/pii/S0167819122000710) \n\n## Acknowledgment\nThis research was supported by the Exascale Computing Project (17-SC-20-SC), \na joint project of the U.S. Department of Energy's Office of Science and National Nuclear Security \nAdministration, responsible for delivering a capable exascale ecosystem, including software, \napplications, and hardware technology, to support the nation's exascale computing imperative.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceed%2Fnekrs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fceed%2Fnekrs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceed%2Fnekrs/lists"}