Merge branch 'AddLicense' into 'master'

Added LLNL open source license and auspices statement

See merge request ExaAM/exaca!49

Former-commit-id: 7221177e03684dc8be81f367108e1faf9fcdcb4d

CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+When contributing to ExaCA, please first discuss the changes you wish to make via issue (or directly with the ExaCA developers).
+Changes should be made through opening a pull request with `master` as the destination branch.
+Coding style from .clang-format and review from at least one ExaCA developer are required.
+
+ExaCA is distributed under the terms of the MIT license. All new contributions must be made under this license.

LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021, Lawrence Livermore National Security, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

NOTICE

@@ -0,0 +1,23 @@
+This work was produced under the auspices of the U.S. Department of
+Energy by Lawrence Livermore National Laboratory under Contract
+DE-AC52-07NA27344 and supported in part by the Exascale Computing Project
+(17-SC-20-SC), a collaborative effort of the U.S. DOE Office of Science
+and the NNSA.
+
+This work was prepared as an account of work sponsored by an agency of
+the United States Government. Neither the United States Government nor
+Lawrence Livermore National Security, LLC, nor any of their employees
+makes any warranty, expressed or implied, or assumes any legal liability
+or responsibility for the accuracy, completeness, or usefulness of any
+information, apparatus, product, or process disclosed, or represents that
+its use would not infringe privately owned rights.
+
+Reference herein to any specific commercial product, process, or service
+by trade name, trademark, manufacturer, or otherwise does not necessarily
+constitute or imply its endorsement, recommendation, or favoring by the
+United States Government or Lawrence Livermore National Security, LLC.
+
+The views and opinions of authors expressed herein do not necessarily
+state or reflect those of the United States Government or Lawrence
+Livermore National Security, LLC, and shall not be used for advertising
+or product endorsement purposes.

README.md

@@ -1,4 +1,5 @@
-# ExaCA-Kokkos
+# ExaCA
+## An exascale-capable cellular automaton for nucleation and grain growth
 ExaCA is a cellular automata (CA) code for grain growth under additive
 manufacturing conditions by ExaAM within the Exascale Computing Project.
 
@@ -108,7 +109,7 @@ cd ../..
 
 ## Run
 
-ExaCA-Kokkos runs using an input file, passed on the command line. Three examples problems are given in the `examples/` directory:
+ExaCA-Kokkos runs using an input file, passed on the command line. Example problems are provided in the `examples/` directory:
 
  * `Inp_AMBenchMultilayer.txt` simulates 4 layers of a representative even-odd layer alternating scan pattern for AM builds
  * `Inp_SimpleRaster.txt` simulates a single layer consisting of four overlapping melt pools
@@ -119,3 +120,16 @@ Run by calling the created executable from the ExaCA root directory:
 ```
 mpiexec -n 1 ./build/install/bin/ExaCA-Kokkos examples/Inp_DirSolidification.txt
 ```
+
+## Contributing
+
+We encourage you to contribute to ExaCA! Please check the
+[contribution guidelines](CONTRIBUTING.md).
+
+## License
+
+ExaCA is distributed under an [MIT license](LICENSE).
+
+## Release
+
+LLNL-CODE-821827

src/CAfunctions.cpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #include "CAfunctions.hpp"
 
 #include "mpi.h"

src/CAfunctions.hpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #ifndef EXACA_FUNCTIONS_HPP
 #define EXACA_FUNCTIONS_HPP
 

src/CAghostnodes.cpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #include "CAghostnodes.hpp"
 
 #include "mpi.h"

src/CAghostnodes.hpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #ifndef EXACA_GHOST_HPP
 #define EXACA_GHOST_HPP
 

src/CAinitialize.cpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #include "CAinitialize.hpp"
 
 #include "CAfunctions.hpp"

src/CAinitialize.hpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #ifndef EXACA_INIT_HPP
 #define EXACA_INIT_HPP
 

src/CAprint.cpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #include "CAprint.hpp"
 
 #include "CAfunctions.hpp"

src/CAprint.hpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #ifndef EXACA_PRINT_HPP
 #define EXACA_PRINT_HPP
 

src/CAtypes.hpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #ifndef EXACA_TYPES_HPP
 #define EXACA_TYPES_HPP
 

src/CAupdate.cpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #include "CAupdate.hpp"
 
 #include "mpi.h"

src/CAupdate.hpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #ifndef EXACA_UPDATE_HPP
 #define EXACA_UPDATE_HPP
 

src/main.cpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #include "runCA.hpp"
 
 #include <Kokkos_Core.hpp>

src/runCA.cpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #include "runCA.hpp"
 
 #include "CAghostnodes.hpp"

src/runCA.hpp

@@ -1,3 +1,8 @@
+// Copyright 2021 Lawrence Livermore National Security, LLC and other ExaCA Project Developers.
+// See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: MIT
+
 #ifndef EXACA_RUN_HPP
 #define EXACA_RUN_HPP