https://github.com/sandialabs/kincat
https://github.com/sandialabs/kincat
scr-2889 snl-science-libs
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sandialabs/kincat
- Owner: sandialabs
- License: gpl-3.0
- Created: 2023-04-11T22:07:53.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T20:37:13.000Z (12 months ago)
- Last Synced: 2025-01-11T15:32:43.606Z (4 months ago)
- Topics: scr-2889, snl-science-libs
- Language: C++
- Homepage:
- Size: 1.93 MB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
/*======================================================================================
kincat version 1.0 Copyright (2023) NTESS https://github.com/sandialabs/kincat Copyright 2023 National Technology & Engineering Solutions of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software. This file is part of KinCat. KinCat is open-source software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. You should have received a copy of the GNU Lesser General Public License along with KinCat. If not, see http://www.gnu.org/licenses/.
Questions? Contact Craig Daniels at [email protected]
Sandia National Laboratories, Albuquerque, NM, USA ======================================================================================*/
KinCat is an open-source 2D lattice KMC simulator. It is written in Python and C++ with the Kokkos library.
KinCat build instructions, file explanations, and other documentation can be found in the kincat.pdf file. It can also be generated in other formats using sphinx from the source files found in the src/sphinx directory. Example input and post-processing files can be found in the src/examples directory. The core c++ code is stored in src/core. However, the preprocessing code, KinCatPy is found in the kincatpy directory. Note that src/unit-test holds code for unit tests to confirm functionality, but these are deprecated.