adding new file header

Pyomo · Sep 13, 2024 · bb6b808 · bb6b808
1 parent 5a6811e
commit bb6b808
Show file tree

Hide file tree

Showing 234 changed files with 1,873 additions and 0 deletions.
diff --git a/addheader.yml b/addheader.yml
@@ -0,0 +1,11 @@
+# Usage: 
+# addheader -c addheader.yml
+---
+root: .
+text: file_header.txt
+patterns:
+   - "*.py"
+   - "__init__.py"
+verbose: 1
+sep_len: 80
+...
diff --git a/doc/src/conf.py b/doc/src/conf.py
@@ -1,5 +1,13 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 #
 # pyomo documentation build configuration file, created by
 # sphinx-quickstart on Mon Dec 12 16:08:36 2016.

diff --git a/examples/acopf3/ACtree.py b/examples/acopf3/ACtree.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 #Tree ideas; dlw Fall 2019
 # Stage numbers and scenario numbers are one-based, but lists are all zero-based
 # Tree node numbers used in node names are zero-based.

diff --git a/examples/acopf3/ccopf2wood.py b/examples/acopf3/ccopf2wood.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # updated april 26
 # mpiexec -np 2 python -m mpi4py ccopf2wood.py 2 3
 # (see the first lines of main() to change instances)

diff --git a/examples/acopf3/ccopf_multistage.py b/examples/acopf3/ccopf_multistage.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # JPW and DLW; July 2019; ccopf create scenario instances for line outages
 # extended Fall 2019 by DLW
 import egret

diff --git a/examples/acopf3/fourstage.py b/examples/acopf3/fourstage.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # four stage test
 # mpiexec -np 8 python -m mpi4py forustage.py 2 2 2 1 0
 # (see the first lines of main() to change instances)

diff --git a/examples/acopf3/rho_setter.py b/examples/acopf3/rho_setter.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # January 2020; rho_setter for ccopf from n-1 stuff of a few years ago 
 
 def generator_p_cost(md, g, output_level):

diff --git a/examples/afew.py b/examples/afew.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # Run a few examples; dlw June 2020
 # See also runall.py
 # Assumes you run from the examples directory.

diff --git a/examples/aircond/aircond_ama.py b/examples/aircond/aircond_ama.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 """
 An example of using amalgamator with 3 cylinders for a multistage problem
 To execute this:

diff --git a/examples/aircond/aircond_cylinders.py b/examples/aircond/aircond_cylinders.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # NOTE: as of March 2022, consider aircondB.py as an alternative to aircond.py
 # Use bundle_pickler.py to create bundle pickles
 # NOTE: As of 3 March 2022, you can't compare pickle bundle problems with non-pickled. See _demands_creator in aircondB.py for more discusion.

diff --git a/examples/aircond/aircond_ef.py b/examples/aircond/aircond_ef.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # multistage (4-stage) example using aircond model. Can be any number of stages, does not support unbalanced trees
 import pyomo.environ as pyo
 import numpy as np

diff --git a/examples/aircond/aircond_seqsampling.py b/examples/aircond/aircond_seqsampling.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # Use the aircond model to illustrate how to use sequential sampling.
 #
 

diff --git a/examples/aircond/bundle_pickler.py b/examples/aircond/bundle_pickler.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # Program to create proper bundles for aircond; DLW march 2022
 # NOTE: As of 3 March 2022, you can't compare pickle bundle problems with non-pickled. See _demands_creator in aircondB.py for more discusion.
 # see try_pickles.bash

diff --git a/examples/battery/battery.py b/examples/battery/battery.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 ''' Solution to the Lagrangian relaxation of a hybrid solar-battery storage
     system from the paper:
 

diff --git a/examples/battery/batteryext.py b/examples/battery/batteryext.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 import mpisppy.extension
 
 class BatteryExtension(mpisppy.extension.Extension):

diff --git a/examples/battery/batterymain.py b/examples/battery/batterymain.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # updated April 2020 so it executes, but this needs a three driver
 from mpisppy.opt.ph import PH
 from battery import scenario_creator, scenario_denouement

diff --git a/examples/distr/distr.py b/examples/distr/distr.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # Network Flow - various formulations
 import pyomo.environ as pyo
 import mpisppy.utils.sputils as sputils

diff --git a/examples/distr/distr_admm_cylinders.py b/examples/distr/distr_admm_cylinders.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # general example driver for distr with cylinders
 import mpisppy.utils.admmWrapper as admmWrapper
 import distr_data

diff --git a/examples/distr/distr_data.py b/examples/distr/distr_data.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # Our data, gives the constraints inside each in region in region_dict_creator
 # and amongst the different regions in inter_region_dict_creator
 # The data slightly differs depending on the number of regions (num_scens) which is created for 2, 3 or 4 regions

diff --git a/examples/distr/distr_ef.py b/examples/distr/distr_ef.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # general example driver for distr with cylinders
 
 # This file can be executed thanks to python distr_ef.py --num-scens 2 --solver-name cplex_direct

diff --git a/examples/distr/globalmodel.py b/examples/distr/globalmodel.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # Distribution example without decomposition, this file is only written to execute the non-scalable example
 
 ### This code line can execute the script for a certain example

diff --git a/examples/farmer/PySP/abstract/ReferenceModel.py b/examples/farmer/PySP/abstract/ReferenceModel.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 #  ___________________________________________________________________________
 #
 #  Pyomo: Python Optimization Modeling Objects

diff --git a/examples/farmer/PySP/concrete/ReferenceModel.py b/examples/farmer/PySP/concrete/ReferenceModel.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 #  ___________________________________________________________________________
 #
 #  Pyomo: Python Optimization Modeling Objects

diff --git a/examples/farmer/cs_farmer.py b/examples/farmer/cs_farmer.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 import datetime
 import logging
 import sys

diff --git a/examples/farmer/farmer.py b/examples/farmer/farmer.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # special for ph debugging DLW Dec 2018
 # unlimited crops
 # ALL INDEXES ARE ZERO-BASED

diff --git a/examples/farmer/farmer_ama.py b/examples/farmer/farmer_ama.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 """
 An example of using amalgamator and solving directly the EF 
 To execute this:

diff --git a/examples/farmer/farmer_cylinders.py b/examples/farmer/farmer_cylinders.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # general example driver for farmer with cylinders
 
 import farmer

diff --git a/examples/farmer/farmer_ef.py b/examples/farmer/farmer_ef.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # This shows two ways to get parameters to the EF for solution; both are fairly short.
 
 import sys

diff --git a/examples/farmer/farmer_lshapedhub.py b/examples/farmer/farmer_lshapedhub.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # general example driver for farmer with cylinders and an l-shape hub
 # NOTE: as of June 2020, it does not use the vanilla cylinders
 

diff --git a/examples/farmer/farmer_ph.py b/examples/farmer/farmer_ph.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # This shows using progressive hedging (PH) algorithm and using its smoothed 
 # version (SPH) to solve the farmer problem. 
 

diff --git a/examples/farmer/farmer_rho_demo.py b/examples/farmer/farmer_rho_demo.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # This program can be used in two different ways:
 # Compute gradient-based cost and rho for a given problem
 # Use the gradient-based rho setter which sets adaptative gradient rho for PH.

diff --git a/examples/farmer/farmer_seqsampling.py b/examples/farmer/farmer_seqsampling.py
@@ -1,3 +1,11 @@
+###############################################################################
+# mpi-sppy: MPI-based Stochastic Programming in PYthon
+#
+# Copyright (c) 2024, Lawrence Livermore National Security, LLC, Alliance for
+# Sustainable Energy, LLC, The Regents of the University of California, et al.
+# All rights reserved. Please see the files COPYRIGHT.md and LICENSE.md for
+# full copyright and license information.
+###############################################################################
 # Illustrate the use of sequential sampling for programmers.
 #
 # This is an atypical program in that it allows for a command line