pyadjoint-ad 2023.0.0__tar.gz

pyadjoint-ad-2023.0.0/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

pyadjoint-ad-2023.0.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.1
+Name: pyadjoint-ad
+Version: 2023.0.0
+Summary: High-level automatic differentiation library.
+Home-page: https://github.com/dolfin-adjoint/pyadjoint
+Author: Jørgen Dokken
+Author-email: dokken@simula.no
+License: LGPL-3.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: scipy>=1.0
+Provides-Extra: moola
+Requires-Dist: moola>=0.1.6; extra == "moola"
+Provides-Extra: test
+Requires-Dist: pytest>=3.10; extra == "test"
+Requires-Dist: flake8; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Provides-Extra: visualisation
+Requires-Dist: tensorflow; extra == "visualisation"
+Requires-Dist: protobuf; extra == "visualisation"
+Requires-Dist: networkx; extra == "visualisation"
+Requires-Dist: pygraphviz; extra == "visualisation"
+Provides-Extra: meshing
+Requires-Dist: pygmsh; extra == "meshing"
+Requires-Dist: meshio; extra == "meshing"
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx-autobuild; extra == "doc"
+Requires-Dist: sphinxcontrib-bibtex; extra == "doc"
+Provides-Extra: all
+Requires-Dist: moola>=0.1.6; extra == "all"
+Requires-Dist: pytest>=3.10; extra == "all"
+Requires-Dist: flake8; extra == "all"
+Requires-Dist: coverage; extra == "all"
+Requires-Dist: tensorflow; extra == "all"
+Requires-Dist: protobuf; extra == "all"
+Requires-Dist: networkx; extra == "all"
+Requires-Dist: pygraphviz; extra == "all"
+Requires-Dist: pygmsh; extra == "all"
+Requires-Dist: meshio; extra == "all"
+Requires-Dist: sphinx; extra == "all"
+Requires-Dist: sphinx-autobuild; extra == "all"
+Requires-Dist: sphinxcontrib-bibtex; extra == "all"
+
+# The algorithmic differentation tool pyadjoint
+
+The full documentation is available [here](https://pyadjoint.org)
+
+Circle CI status: [![CircleCI](https://circleci.com/gh/dolfin-adjoint/pyadjoint.svg?style=svg)](https://circleci.com/gh/dolfin-adjoint/pyadjoint)
+
+
+# Contributing
+
+We love pull requests from everyone. 
+
+Fork, then clone the repository at https://github.com/dolfin-adjoint/pyadjoint
+
+Make sure the tests pass:
+
+    py.test tests/pyadjoint
+
+Make your change. Add tests for your change. Make the tests pass:
+
+    py.test tests/pyadjoint
+
+Push to your fork and [submit a pull request][pr].
+
+[pr]: https://github.com/dolfin-adjoint/pyadjoint/pulls
+
+At this point you're waiting on us. We may suggest
+some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted:
+
+* Write tests.
+* Add Python docstrings that follow the [Google Style][style].
+* Write good commit and pull request message.
+
+[style]: http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
+
+# Licence
+This software is licensed under the [GNU LGPL v3][license].
+
+[license]: https://github.com/dolfin-adjoint/pyadjoint/raw/master/LICENSE

pyadjoint-ad-2023.0.0/README.md

@@ -0,0 +1,40 @@
+# The algorithmic differentation tool pyadjoint
+
+The full documentation is available [here](https://pyadjoint.org)
+
+Circle CI status: [![CircleCI](https://circleci.com/gh/dolfin-adjoint/pyadjoint.svg?style=svg)](https://circleci.com/gh/dolfin-adjoint/pyadjoint)
+
+
+# Contributing
+
+We love pull requests from everyone. 
+
+Fork, then clone the repository at https://github.com/dolfin-adjoint/pyadjoint
+
+Make sure the tests pass:
+
+    py.test tests/pyadjoint
+
+Make your change. Add tests for your change. Make the tests pass:
+
+    py.test tests/pyadjoint
+
+Push to your fork and [submit a pull request][pr].
+
+[pr]: https://github.com/dolfin-adjoint/pyadjoint/pulls
+
+At this point you're waiting on us. We may suggest
+some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted:
+
+* Write tests.
+* Add Python docstrings that follow the [Google Style][style].
+* Write good commit and pull request message.
+
+[style]: http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
+
+# Licence
+This software is licensed under the [GNU LGPL v3][license].
+
+[license]: https://github.com/dolfin-adjoint/pyadjoint/raw/master/LICENSE

pyadjoint-ad-2023.0.0/firedrake_adjoint/__init__.py

@@ -0,0 +1,12 @@
+# flake8: noqa
+
+import warnings
+
+from firedrake.adjoint import *
+
+continue_annotation()
+
+warnings.warn("""The firedrake_adjoint module is deprecated.
+
+Instead, use the firedrake.adjoint module and explicitly start taping
+by calling continue_annotation().""", FutureWarning)

pyadjoint-ad-2023.0.0/numpy_adjoint/__init__.py

@@ -0,0 +1,18 @@
+# flake8: noqa
+
+import pyadjoint
+__version__ = pyadjoint.__version__
+__author__ = 'Sebastian Kenji Mitusch'
+__credits__ = []
+__license__ = 'LGPL-3'
+__maintainer__ = 'Sebastian Kenji Mitusch'
+__email__ = 'sebastkm@simula.no'
+
+
+from .array import ndarray
+
+# Use pyadjoint AdjFloat for numpy.float64.
+import numpy
+from pyadjoint.overloaded_type import register_overloaded_type
+from pyadjoint.adjfloat import AdjFloat
+register_overloaded_type(AdjFloat, numpy.float64)

pyadjoint-ad-2023.0.0/numpy_adjoint/array.py

@@ -0,0 +1,56 @@
+import numpy
+from pyadjoint.overloaded_type import OverloadedType, register_overloaded_type, create_overloaded_object
+from pyadjoint.tape import get_working_tape, stop_annotating, annotate_tape
+from pyadjoint.block import Block
+
+
+@register_overloaded_type
+class ndarray(OverloadedType, numpy.ndarray):
+    def __init__(self, *args, **kwargs):
+        pass
+
+    @classmethod
+    def _ad_init_object(cls, obj):
+        return cls(obj.shape, numpy.float_, buffer=obj)
+
+    def _ad_create_checkpoint(self):
+        return self.copy()
+
+    def _ad_restore_at_checkpoint(self, checkpoint):
+        return checkpoint
+
+    def __getitem__(self, item):
+        annotate = annotate_tape()
+        if annotate:
+            block = NumpyArraySliceBlock(self, item)
+            tape = get_working_tape()
+            tape.add_block(block)
+
+        with stop_annotating():
+            out = numpy.ndarray.__getitem__(self, item)
+
+        if annotate:
+            out = create_overloaded_object(out)
+            block.add_output(out.create_block_variable())
+        return out
+
+    def _ad_convert_type(self, value, options={}):
+        return value
+
+    def __array_finalize__(self, obj):
+        OverloadedType.__init__(self)
+
+
+class NumpyArraySliceBlock(Block):
+    def __init__(self, array, item):
+        super().__init__()
+        self.add_dependency(array)
+        self.item = item
+
+    def evaluate_adj_component(self, inputs, adj_inputs, block_variable, idx, prepared=None):
+        adj_output = numpy.zeros(inputs[0].shape)
+        adj_output[self.item] = adj_inputs[0]
+        return adj_output
+
+    def recompute_component(self, inputs, block_variable, idx, prepared):
+        return inputs[0][self.item]

pyadjoint-ad-2023.0.0/pyadjoint/__init__.py

@@ -0,0 +1,25 @@
+# flake8: noqa
+
+__version__ = '2019.1.2'
+__author__  = 'Sebastian Kenji Mitusch'
+__credits__ = []
+__license__ = 'LGPL-3'
+__maintainer__ = 'Sebastian Kenji Mitusch'
+__email__ = 'sebastkm@math.uio.no'
+
+from .block import Block
+from .tape import (Tape,
+                   set_working_tape, get_working_tape, no_annotations,
+                   annotate_tape, stop_annotating, pause_annotation, continue_annotation)
+from .adjfloat import AdjFloat
+from .reduced_functional import ReducedFunctional
+from .drivers import compute_gradient, compute_hessian, solve_adjoint
+from .verification import taylor_test, taylor_to_dict
+from .overloaded_type import OverloadedType, create_overloaded_object
+from .control import Control
+from .optimization.optimization import minimize, maximize, print_optimization_methods
+from .optimization.optimization_problem import MinimizationProblem
+from .optimization.ipopt_solver import IPOPTSolver
+from .optimization.rol_solver import ROLSolver
+from .optimization.constraints import InequalityConstraint, EqualityConstraint
+from .optimization.moola_problem import MoolaOptimizationProblem