update the license and copyright notices (#25)

* update the license and copyright notices to organization standard practices * add contributors and NOTICE * finish updating contributors listing for the examples repo
GMLC-TDC · Oct 17, 2019 · 683aeef · 683aeef
1 parent 5f4affb
commit 683aeef
Show file tree

Hide file tree

Showing 40 changed files with 322 additions and 137 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,8 +1,11 @@
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Copyright (c) 2017-2019, Battelle Memorial Institute; Lawrence Livermore
+# National Security, LLC; Alliance for Sustainable Energy, LLC.
+# See the top-level NOTICE for additional details.
+# All rights reserved.
 #
-# Copyright © 2017-2018, Battelle Memorial Institute; Lawrence Livermore National
-# Security, LLC; Alliance for Sustainable Energy, LLC All rights reserved. See LICENSE
-# file and DISCLAIMER for more details.
-#
+# SPDX-License-Identifier: BSD-3-Clause
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 cmake_minimum_required(VERSION 3.4)
 cmake_policy(VERSION 3.4)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,26 @@
+# Contributing to HELICS and the GMLC-TDC archives
+
+:+1: First off, thank you for taking the time to contribute! :+1:
+
+The following is a set of guidelines for contributing to HELICS and associated projects. These are suggested guidelines. Use your best judgment.
+
+## Table Of Contents
+
+## Licensing
+HELICS is distributed under the terms of the BSD-3 clause license. All new
+contributions must be made under this [LICENSE](LICENSE) in accordance with the Github [terms of service](https://help.github.com/en/articles/github-terms-of-service#6-contributions-under-repository-license), which uses inbound=outbound policy.  By submitting a pull request you are acknowledging that you have the right to license your code under these terms.
+
+If you just have a question check out [![Gitter chat](https://badges.gitter.im/GMLC-TDC/HELICS.png)](https://gitter.im/GMLC-TDC/HELICS)
+
+## How Can I Contribute
+
+### Reporting Bugs
+
+This section guides you through submitting a bug report for the containers library. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
+
+When you are creating a bug report, please include as many details as possible.  Frequently, helpful information includes operating system, version, compiler used, API, interface, and some details about the function or operation being performed.
+
+> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
+
+### Submitting a pull request
+Typically you would want to submit a pull request against the develop branch.  That branch gets merged into master periodically but the develop branch is the active development branch where all the code is tested and merged before making a release.  There is a [Pull request template](.github/PULL_REQUEST_TEMPLATE.md) that will guide you through the needed information. 
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -0,0 +1,26 @@
+# Contributors
+This file describes the contributors to the HELICS-examples library and the software used as part of this project It is part of the GMLC-TDC project and used in the HELICS project.  HELICS is a joint project between PNNL, LLNL, and NREL, with contributions from many other national Labs
+If you would like to contribute to the HELICS-examples, HELICS, or any of the GMLC-TDC related repositories see [CONTRIBUTING](CONTRIBUTING.md)
+## Individual contributors
+### Pacific Northwest National Lab
+-  Swetha Niddodi
+
+### Lawrence Livermore National Lab
+ - Ryan Mast
+ - Philip Top
+
+### National Renewable Energy Lab
+ - Dheepak Krishnamurthy
+ - Brian Palmentier
+
+### Other
+[Bryan Richardson](https://github.com/activeshadow) Active Shadow LLC
+[Cody Rooks](https://github.com/rookscody) University of Tennessee (Knoxville)
+
+## Used Libraries or Code
+### [HELICS](https://github.com/GMLC-TDC/HELICS)  
+Most of the original code for this library was pulled from use inside HELICS. Several examples were initially included in the HELICS repo but were pulled out when this repo was created  HELICS is released with a BSD-3-Clause license.
+
+### cmake scripts
+Several cmake scripts came from other sources and were either used or modified for use in HELICS.
+ - CLI11 [CLI11](https://github.com/CLIUtils/CLI11)  while CLI11 was not used directly many of the CI scripts and structure were borrowed to set up the CI builds.  
diff --git a/LICENSE b/LICENSE
@@ -1,5 +1,6 @@
-Copyright (c) 2017-2019,
-Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC.
+BSD 3-Clause License
+
+Copyright (c) 2017-2019, Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

diff --git a/NOTICE b/NOTICE
@@ -0,0 +1,61 @@
+This material was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor any copyright owner listed below, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, 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 any agency thereof, or copyright owner. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.
+Copyright Owners:
+Battelle Memorial Institute;
+Lawrence Livermore National Security, LLC;
+Alliance for Sustainable Energy, LLC
+
+
+Open Source Disclaimer:
+This material was prepared as an account of work sponsored by an agency of the United States Government.  Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, 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 any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.
+
+PACIFIC NORTHWEST NATIONAL LABORATORY operated by BATTELLE for the UNITED STATES DEPARTMENT OF ENERGY under Contract DE-AC05-76RL01830
+
+Attribution:
+This software was co-developed by Pacific Northwest National Laboratory, operated by the Battelle Memorial Institute; the National Renewable Energy Laboratory, operated by the Alliance for Sustainable Energy, LLC; and the Lawrence Livermore National Laboratory, operated by Lawrence Livermore National Security, LLC.
+
+GU Acknowledgement:
+These data were produced by BATTELLE under Contract No. DE AC05-76RL01830 with the U.S. Department of Energy (DOE).  For a five-year period from October 31, 2014, the U.S. Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, and perform publicly and display publicly, by or on behalf of the U.S. Government.  There is provision for the possible extension of the term of this license.  Subsequent to that period or any extension granted, the U.S. Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so.  The specific term of the license can be identified by inquiry made to BATTELLE or DOE.  Neither the United States nor DOE, nor any of their employees, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness of any data, apparatus, product, or process disclosed, or represents that its use would not infringe privately owned rights.
+
+Disclaimer:
+This Agreement is entered into by BATTELLE in its private capacity.  It is understood and agreed that the U.S. Government is not a party to this Agreement and in no manner whatsoever shall be liable for nor assume any responsibility or obligation for any claim, cost or damages arising out of or resulting from this Agreement or the subject matter licensed.
+
+LICENSEE recognizes that the Licensed Software is provided by BATTELLE on an as-is basis.  Nothing in this Agreement shall be deemed to be a representation or warranty by BATTELLE, or the U.S. Government, of the accuracy, safety or usefulness for any purpose, of the Licensed Software at any time made available by BATTELLE.  Neither the U.S. Government nor BATTELLE nor any affiliated company of BATTELLE shall have any liability whatsoever to LICENSEE or any other person for or on account of any injury, loss, or damage, of any kind or nature sustained by, or any damage assessed or asserted against, or any other liability incurred by or imposed upon LICENSEE or any other person, arising out of or in connection with or resulting from (i) the production, use or sale of the Licensed Software or any apparatus or product, or process; (ii) the use of any technical information, techniques, or practices disclosed by BATTELLE; or (iii) any advertising or other promotional activities with respect to any of the foregoing, and LICENSEE shall hold the U.S. Government, BATTELLE, and any affiliated company of BATTELLE, harmless in the event the U.S. Government, BATTELLE, or any affiliated company of BATTELLE, is held liable.  In the event BATTELLE is determined to be liable to LICENSEE for any reason arising out of this Agreement, despite the above limitation, the maximum extent of BATTELLE's liability shall be the license fee.
+
+BATTELLE represents that it has the right to grant all of the rights granted herein, except as to such rights as the Government of the United States of America may have or may assert.
+
+Enduser Terms:
+This Agreement is entered into by BATTELLE in its private capacity.  It is understood and agreed that the U.S. Government is not a party to this Agreement and in no manner whatsoever shall be liable for nor assume any responsibility or obligation for any claim, cost or damages arising out of or resulting from this Agreement or the subject matter licensed.
+
+LICENSEE recognizes that the Licensed Software is provided by BATTELLE on an as-is basis.  Nothing in this Agreement shall be deemed to be a representation or warranty by BATTELLE, or the U.S. Government, of the accuracy, safety or usefulness for any purpose, of the Licensed Software at any time made available by BATTELLE.  Neither the U.S. Government nor BATTELLE nor any affiliated company of BATTELLE shall have any liability whatsoever to LICENSEE or any other person for or on account of any injury, loss, or damage, of any kind or nature sustained by, or any damage assessed or asserted against, or any other liability incurred by or imposed upon LICENSEE or any other person, arising out of or in connection with or resulting from (i) the production, use or sale of the Licensed Software or any apparatus or product, or process; (ii) the use of any technical information, techniques, or practices disclosed by BATTELLE; or (iii) any advertising or other promotional activities with respect to any of the foregoing, and LICENSEE shall hold the U.S. Government, BATTELLE, and any affiliated company of BATTELLE, harmless in the event the U.S. Government, BATTELLE, or any affiliated company of BATTELLE, is held liable.  In the event BATTELLE is determined to be liable to LICENSEE for any reason arising out of this Agreement, despite the above limitation, the maximum extent of BATTELLE's liability shall be the license fee.
+
+BATTELLE represents that it has the right to grant all of the rights granted herein, except as to such rights as the Government of the United States of America may have or may assert.
+
+LLNL NOTICE
+
+portions of the code written by LLNL with release number
+LLNL-CODE-739319
+OCEC-17-164
+
+Portions of this work were produced under the auspices of the U.S. Department of
+Energy by Lawrence Livermore National Laboratory under Contract
+DE-AC52-07NA27344.
+
+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.
diff --git a/README.md b/README.md
@@ -2,5 +2,21 @@
 
 Examples for using HELICS with a variety of the supported programming languages
 
+All C and C++ examples can be build through CMAKE.  They can be build from individual folders or by running CMAKE on the main folder
+
 On Windows and systems with HELICS installed in a non-system search path, the `HELICS_DIR` environment variable can be set to the folder HELICS was installed to (the one containing `bin`, `include`, and `lib`/`lib64` subfolders). Alternatives to this include adding the HELICS install folder to your `PATH` environment variable, or setting the `CMAKE_PREFIX_PATH` to the HELICS install folder (either as an environment variable, or using the `-DCMAKE_PREFIX_PATH=value` CMake
 argument.
+
+## Source Repo
+
+The HELICS source code is hosted on GitHub: [https://github.com/GMLC-TDC/HELICS](https://github.com/GMLC-TDC/HELICS)
+
+## Release
+HELICS-Examples is distributed under the terms of the BSD-3 clause license. All new
+contributions must be made under this license. [LICENSE](LICENSE)
+
+SPDX-License-Identifier: BSD-3-Clause
+
+portions of the code written by LLNL with release number
+LLNL-CODE-739319
+
diff --git a/c/comboFederate1/CMakeLists.txt b/c/comboFederate1/CMakeLists.txt
@@ -1,8 +1,11 @@
-##############################################################################
-# Copyright © 2018,
-# Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC
-#All rights reserved. See LICENSE file and DISCLAIMER for more details.
-##############################################################################
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Copyright (c) 2017-2019, Battelle Memorial Institute; Lawrence Livermore
+# National Security, LLC; Alliance for Sustainable Energy, LLC.
+# See the top-level NOTICE for additional details.
+# All rights reserved.
+#
+# SPDX-License-Identifier: BSD-3-Clause
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 cmake_minimum_required(VERSION 3.4)
 

diff --git a/c/comboFederate1/comboFed.c b/c/comboFederate1/comboFed.c
@@ -1,7 +1,8 @@
 /*
-Copyright © 2017-2018,
-Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC
-All rights reserved. See LICENSE file and DISCLAIMER for more details.
+Copyright © 2017-2019,
+Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC.  See
+the top-level NOTICE for additional details. All rights reserved.
+SPDX-License-Identifier: BSD-3-Clause
 */
 #include <helics/shared_api_library/MessageFederate.h>
 #include <helics/shared_api_library/ValueFederate.h>

diff --git a/c/hello_world/CMakeLists.txt b/c/hello_world/CMakeLists.txt
@@ -1,8 +1,11 @@
-##############################################################################
-# Copyright © 2018,
-# Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC
-#All rights reserved. See LICENSE file and DISCLAIMER for more details.
-##############################################################################
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Copyright (c) 2017-2019, Battelle Memorial Institute; Lawrence Livermore
+# National Security, LLC; Alliance for Sustainable Energy, LLC.
+# See the top-level NOTICE for additional details.
+# All rights reserved.
+#
+# SPDX-License-Identifier: BSD-3-Clause
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 cmake_minimum_required(VERSION 3.4)
 

diff --git a/c/hello_world/hello_world_receiver.c b/c/hello_world/hello_world_receiver.c
@@ -1,7 +1,8 @@
 /*
-Copyright © 2017-2018,
-Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC
-All rights reserved. See LICENSE file and DISCLAIMER for more details.
+Copyright © 2017-2019,
+Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC.  See
+the top-level NOTICE for additional details. All rights reserved.
+SPDX-License-Identifier: BSD-3-Clause
 */
 
 #include <helics/shared_api_library/ValueFederate.h>

diff --git a/c/hello_world/hello_world_sender.c b/c/hello_world/hello_world_sender.c
@@ -1,7 +1,8 @@
 /*
-Copyright © 2017-2018,
-Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC
-All rights reserved. See LICENSE file and DISCLAIMER for more details.
+Copyright © 2017-2019,
+Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC.  See
+the top-level NOTICE for additional details. All rights reserved.
+SPDX-License-Identifier: BSD-3-Clause
 */
 
 /* include the HELICS header for value Federates*/

diff --git a/c/messageFederate1/CMakeLists.txt b/c/messageFederate1/CMakeLists.txt
@@ -1,8 +1,11 @@
-##############################################################################
-# Copyright © 2018,
-# Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC
-#All rights reserved. See LICENSE file and DISCLAIMER for more details.
-##############################################################################
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Copyright (c) 2017-2019, Battelle Memorial Institute; Lawrence Livermore
+# National Security, LLC; Alliance for Sustainable Energy, LLC.
+# See the top-level NOTICE for additional details.
+# All rights reserved.
+#
+# SPDX-License-Identifier: BSD-3-Clause
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 cmake_minimum_required(VERSION 3.4)
 

diff --git a/c/messageFederate1/messageFed.c b/c/messageFederate1/messageFed.c
@@ -1,7 +1,8 @@
 /*
-Copyright © 2017-2018,
-Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC
-All rights reserved. See LICENSE file and DISCLAIMER for more details.
+Copyright © 2017-2019,
+Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC.  See
+the top-level NOTICE for additional details. All rights reserved.
+SPDX-License-Identifier: BSD-3-Clause
 */
 #include <helics/shared_api_library/MessageFederate.h>
 #include <stdio.h>