lbfgsb 0.1.0__tar.gz

lbfgsb-0.1.0/AUTHORS.rst

@@ -0,0 +1,20 @@
+=======
+Credits
+=======
+
+This demonstrator project was initiated as part of Antoine COLLET's thesis (add ref)
+between 2020 and 2024. Although the current version of the LBFGSB code was written
+in its entirety by Antoine COLLET, Irina SIN and Hervé CHAURIS, researchers
+at the Ecole des Mines de Paris and supervisors for this work, are the writters of the
+initial prototype (2020) and significantly contributed to the scientific content
+and to the derivation of the equations.
+
+Development Lead
+----------------
+
+* Antoine Collet <antoine.collet5@gmail.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

lbfgsb-0.1.0/CHANGELOG.rst

@@ -0,0 +1,8 @@
+==============
+Changelog
+==============
+
+0.1.0 (2023-08-04)
+------------------
+
+* First release on PyPI.

lbfgsb-0.1.0/CONTRIBUTING.rst

@@ -0,0 +1,143 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome and greatly appreciated! Every little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Reporting of Bugs and Defects
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+A defect is any variance between actual and expected result, this can include bugs in the code or defects in the documentation or visualization.
+
+Please report defects to the `the GitLab Tracker <https://github.com/antoinecollet5/lbfgsb/issues>`_
+using the **Defect** description template.
+
+`Merge Request Guidelines`_ for details on best developmental practices.
+
+Features
+~~~~~~~~
+
+If you wish to propose a feature, please file an issue on `the GitLab Tracker <https://github.com/antoinecollet5/lbfgsb/issues>`_ using the **Feature** description template. Community members will help refine and design your idea until it is ready for implementation.
+Via these early reviews, we hope to steer contributors away from producing work outside of the project boundaries.
+
+Please see the `Merge Request Guidelines`_ for details on best developmental practices.
+
+Documentation
+~~~~~~~~~~~~~
+
+Python Reactive Transport Inversion Demonstrator could always use more documentation, whether as part of the official Python Reactive Transport Inversion Demonstrator docs, in docstrings, tutorials and even on the web in blog posts, articles and such.
+
+For docstrings, please use the `numpy docstring format <https://numpydoc.readthedocs.io/en/latest/format.html>`_.
+
+Working on issues
+------------------
+
+After an issue is created, the progress of the issues is tracked on the `GitHub issue board <https://github.com/antoinecollet5/lbfgsb/pulse>`_.
+The maintainers will update the state using `labels <https://github.com/antoinecollet5/lbfgsblabels>`_ .
+Once an issue is ready for review a Merge Request can be opened.
+
+
+
+Merge Request Guidelines
+--------------------------
+
+Please make merge requests into the *develop* branch (not the *master* branch). Each request should be self-contained and address a single issue on the tracker.
+
+Before you submit a merge request, check that it meets these guidelines:
+
+1. New code should be fully tested; running pytest in coverage mode can help identify gaps.
+2. Documentation is updated, this includes docstrings and any necessary changes to existing tutorials, user documentation and so forth. We use the `numpy docstring format <https://numpydoc.readthedocs.io/en/latest/format.html>`_.
+3. The CI pipelines should pass for all merge requests.
+
+   - Check the status of the pipelines, the status is also reported in the merge request.
+   - flake8 linter should pass.
+   - No degradation in code coverage.
+   - Documentation should build.
+4. Ensure your merge request contains a clear description of the changes made and how it addresses the issue. If useful, add a screenshot to showcase your work to facilitate an easier review.
+
+Congratulations! The maintainers will now review your work and suggest any necessary changes.
+If no changes are required, a maintainer will "approve" the review.
+If you are
+Thank you very much
+for your hard work in improving Python Reactive Transport Inversion Demonstrator.
+
+
+Setting up lbfgsb for local development
+---------------------------------------
+
+Ready to contribute? Here's how to set up `Python Reactive Transport Inversion Demonstrator` for local development.
+
+1. Fork the `lbfgsb` repo on GitLab.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/lbfgsb.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv lbfgsb
+    $ cd lbfgsb/
+    $ pip install -e .
+    $ pip install -r requirements_dev.txt
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8, the tests and have test coverage::
+
+    $ flake8 lbfgsb tests
+    $ pytest --cov
+
+  If you have worked on documentation instead of code you may want to preview how your docs look locally.
+  You can build the docs locally using:
+
+  .. code-block:: shell
+
+      $ cd docs
+      $ make html
+
+  The docs will be located in `lbfgsb/docs/_build`.
+
+
+6. Commit your changes and push your branch to GitLab::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a merge request through the GitLab website.
+
+
+.. tip:: Autobuild documentation
+
+    If you are working on documentation it can be useful to automatically rebuild
+    the docs after every change. This can be done using the `sphinx-autobuild`
+    package. Through the following command:
+
+
+    .. code-block:: shell
+
+        $ sphinx-autobuild docs docs/_build/html
+
+    The documentation will then be hosted on `localhost:8000`
+
+.. tip:: Running parts of the test suite
+
+    To run only parts of the test suite, specify the folder in which to look for
+    tests as an argument to pytest. The following example
+
+
+    .. code-block:: shell
+
+        $ py.test tests/measurement --cov lbfgsb/measurement
+
+    will look for tests located in the tests/measurement directory and report test coverage of the lbfgsb/measurement module.

lbfgsb-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Antoine COLLET
+
+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.

lbfgsb-0.1.0/MANIFEST.in

@@ -0,0 +1,11 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include CHANGELOG.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

lbfgsb-0.1.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.1
+Name: lbfgsb
+Version: 0.1.0
+Summary: Reactive Transport Inversion demonstrator written in Python.
+Home-page: https://github.com/antoinecollet5/lbfgsb
+Author: attr: lbfgsb.__author__
+Author-email: antoinecollet5@gmail.com
+License: MIT license
+Keywords: Inversion,Gradient descent,Reactive transport,Parameters estimation,Adjoint State,Demonstrator
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: <4,>=3.7
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: importlib_metadata
+Requires-Dist: numpy
+
+======
+LBFGSB
+======
+
+|License| |Stars| |Python| |PyPI| |Downloads| |Build Status| |Documentation Status| |Coverage| |Codacy| |Precommit: enabled| |Code style: black| |Ruff| |Mypy| |DOI|
+
+A python impementation of the famous L-BFGS-B quasi-Newton solver [1].
+
+This code is a python port of the famous implementation of Limited-memory
+Broyden-Fletcher-Goldfarb-Shanno (L-BFGS), algorithm 778 written in Fortran [2,3]
+(last update in 2011).
+Note that this is not a wrapper like `minimize`` in scipy but a complete
+reimplementation (pure python).
+The original Fortran code can be found here: https://dl.acm.org/doi/10.1145/279232.279236
+
+References
+----------
+[1] R. H. Byrd, P. Lu and J. Nocedal. A Limited Memory Algorithm for Bound
+    Constrained Optimization, (1995), SIAM Journal on Scientific and
+    Statistical Computing, 16, 5, pp. 1190-1208.
+[2] C. Zhu, R. H. Byrd and J. Nocedal. L-BFGS-B: Algorithm 778: L-BFGS-B,
+    FORTRAN routines for large scale bound constrained optimization (1997),
+    ACM Transactions on Mathematical Software, 23, 4, pp. 550 - 560.
+[3] J.L. Morales and J. Nocedal. L-BFGS-B: Remark on Algorithm 778: L-BFGS-B,
+    FORTRAN routines for large scale bound constrained optimization (2011),
+    ACM Transactions on Mathematical Software, 38, 1.
+
+The aim of this reimplementation was threefold. First, familiarize ourselves with
+the code, its logic and inner optimizations. Second, gain access to certain
+parameters that are hard-coded in the Fortran code and cannot be modified (typically
+wolfe conditions parameters for the line search). Third,
+implement additional functionalities that require significant modification of
+the code core.
+
+* Free software: MIT license
+* Documentation: https://lbfgsb.readthedocs.io.
+
+.. |License| image:: https://img.shields.io/badge/License-MIT license-blue.svg
+    :target: https://github.com/antoinecollet5/lbfgsb/-/blob/master/LICENSE
+
+.. |Stars| image:: https://img.shields.io/github/stars/antoinecollet5/lbfgsb.svg?style=social&label=Star&maxAge=2592000
+    :target: https://github.com/antoinecollet5/lbfgsb/stargazers
+    :alt: Stars
+
+.. |Python| image:: https://img.shields.io/pypi/pyversions/lbfgsb.svg
+    :target: https://pypi.org/pypi/lbfgsb
+    :alt: Python
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/lbfgsb.svg
+    :target: https://pypi.org/pypi/lbfgsb
+    :alt: PyPI
+
+.. |Downloads| image:: https://static.pepy.tech/badge/lbfgsb
+    :target: https://pepy.tech/project/lbfgsb
+    :alt: Downoads
+
+.. |Build Status| image:: https://github.com/antoinecollet5/lbfgsb/actions/workflows/main.yml/badge.svg
+    :target: https://github.com/antoinecollet5/lbfgsb/actions/workflows/main.yml
+    :alt: Build Status
+
+.. |Documentation Status| image:: https://readthedocs.org/projects/lbfgsb/badge/?version=latest
+    :target: https://lbfgsb.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. |Coverage| image:: https://codecov.io/gh/antoinecollet5/lbfgsb/branch/master/graph/badge.svg?token=ISE874MMOF
+    :target: https://codecov.io/gh/antoinecollet5/lbfgsb
+    :alt: Coverage
+
+.. |Codacy| image:: https://app.codacy.com/project/badge/Grade/a3ad37554c5845e6a27e096e77dcca2f
+    :target: https://app.codacy.com/gh/antoinecollet5/lbfgsb/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
+    :alt: codacy
+
+.. |Precommit: enabled| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
+   :target: https://github.com/pre-commit/pre-commit
+
+.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
+    :target: https://github.com/psf/black
+    :alt: Black
+
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+
+.. |Mypy| image:: https://www.mypy-lang.org/static/mypy_badge.svg
+    :target: https://mypy-lang.org/
+    :alt: Checked with mypy
+
+.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.11384588.svg
+   :target: https://doi.org/10.5281/zenodo.11384588
+
+==============
+Changelog
+==============
+
+0.1.0 (2023-08-04)
+------------------
+
+* First release on PyPI.
+
+MIT License
+
+Copyright (c) 2024 Antoine COLLET
+
+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.

lbfgsb-0.1.0/README.rst

@@ -0,0 +1,89 @@
+======
+LBFGSB
+======
+
+|License| |Stars| |Python| |PyPI| |Downloads| |Build Status| |Documentation Status| |Coverage| |Codacy| |Precommit: enabled| |Code style: black| |Ruff| |Mypy| |DOI|
+
+A python impementation of the famous L-BFGS-B quasi-Newton solver [1].
+
+This code is a python port of the famous implementation of Limited-memory
+Broyden-Fletcher-Goldfarb-Shanno (L-BFGS), algorithm 778 written in Fortran [2,3]
+(last update in 2011).
+Note that this is not a wrapper like `minimize`` in scipy but a complete
+reimplementation (pure python).
+The original Fortran code can be found here: https://dl.acm.org/doi/10.1145/279232.279236
+
+References
+----------
+[1] R. H. Byrd, P. Lu and J. Nocedal. A Limited Memory Algorithm for Bound
+    Constrained Optimization, (1995), SIAM Journal on Scientific and
+    Statistical Computing, 16, 5, pp. 1190-1208.
+[2] C. Zhu, R. H. Byrd and J. Nocedal. L-BFGS-B: Algorithm 778: L-BFGS-B,
+    FORTRAN routines for large scale bound constrained optimization (1997),
+    ACM Transactions on Mathematical Software, 23, 4, pp. 550 - 560.
+[3] J.L. Morales and J. Nocedal. L-BFGS-B: Remark on Algorithm 778: L-BFGS-B,
+    FORTRAN routines for large scale bound constrained optimization (2011),
+    ACM Transactions on Mathematical Software, 38, 1.
+
+The aim of this reimplementation was threefold. First, familiarize ourselves with
+the code, its logic and inner optimizations. Second, gain access to certain
+parameters that are hard-coded in the Fortran code and cannot be modified (typically
+wolfe conditions parameters for the line search). Third,
+implement additional functionalities that require significant modification of
+the code core.
+
+* Free software: MIT license
+* Documentation: https://lbfgsb.readthedocs.io.
+
+.. |License| image:: https://img.shields.io/badge/License-MIT license-blue.svg
+    :target: https://github.com/antoinecollet5/lbfgsb/-/blob/master/LICENSE
+
+.. |Stars| image:: https://img.shields.io/github/stars/antoinecollet5/lbfgsb.svg?style=social&label=Star&maxAge=2592000
+    :target: https://github.com/antoinecollet5/lbfgsb/stargazers
+    :alt: Stars
+
+.. |Python| image:: https://img.shields.io/pypi/pyversions/lbfgsb.svg
+    :target: https://pypi.org/pypi/lbfgsb
+    :alt: Python
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/lbfgsb.svg
+    :target: https://pypi.org/pypi/lbfgsb
+    :alt: PyPI
+
+.. |Downloads| image:: https://static.pepy.tech/badge/lbfgsb
+    :target: https://pepy.tech/project/lbfgsb
+    :alt: Downoads
+
+.. |Build Status| image:: https://github.com/antoinecollet5/lbfgsb/actions/workflows/main.yml/badge.svg
+    :target: https://github.com/antoinecollet5/lbfgsb/actions/workflows/main.yml
+    :alt: Build Status
+
+.. |Documentation Status| image:: https://readthedocs.org/projects/lbfgsb/badge/?version=latest
+    :target: https://lbfgsb.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. |Coverage| image:: https://codecov.io/gh/antoinecollet5/lbfgsb/branch/master/graph/badge.svg?token=ISE874MMOF
+    :target: https://codecov.io/gh/antoinecollet5/lbfgsb
+    :alt: Coverage
+
+.. |Codacy| image:: https://app.codacy.com/project/badge/Grade/a3ad37554c5845e6a27e096e77dcca2f
+    :target: https://app.codacy.com/gh/antoinecollet5/lbfgsb/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
+    :alt: codacy
+
+.. |Precommit: enabled| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
+   :target: https://github.com/pre-commit/pre-commit
+
+.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
+    :target: https://github.com/psf/black
+    :alt: Black
+
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+
+.. |Mypy| image:: https://www.mypy-lang.org/static/mypy_badge.svg
+    :target: https://mypy-lang.org/
+    :alt: Checked with mypy
+
+.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.11384588.svg
+   :target: https://doi.org/10.5281/zenodo.11384588

lbfgsb-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = lbfgsb
+SOURCEDIR     = sources
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

lbfgsb-0.1.0/docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=sources
+set BUILDDIR=build
+set SPHINXPROJ=lbfgsb
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

lbfgsb-0.1.0/docs/sources/_autosummary/_autosummary/lbfgsb.base.clip2bounds.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+lbfgsb.base.clip2bounds
+=======================
+
+.. currentmodule:: lbfgsb.base
+
+.. autofunction:: clip2bounds

lbfgsb-0.1.0/docs/sources/_autosummary/_autosummary/lbfgsb.base.count_var_at_bounds.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+lbfgsb.base.count\_var\_at\_bounds
+==================================
+
+.. currentmodule:: lbfgsb.base
+
+.. autofunction:: count_var_at_bounds

lbfgsb-0.1.0/docs/sources/_autosummary/_autosummary/lbfgsb.base.display_iter.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+lbfgsb.base.display\_iter
+=========================
+
+.. currentmodule:: lbfgsb.base
+
+.. autofunction:: display_iter

lbfgsb-0.1.0/docs/sources/_autosummary/_autosummary/lbfgsb.base.display_iter_ensemble.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+lbfgsb.base.display\_iter\_ensemble
+===================================
+
+.. currentmodule:: lbfgsb.base
+
+.. autofunction:: display_iter_ensemble

lbfgsb-0.1.0/docs/sources/_autosummary/_autosummary/lbfgsb.base.display_results.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+lbfgsb.base.display\_results
+============================
+
+.. currentmodule:: lbfgsb.base
+
+.. autofunction:: display_results

lbfgsb-0.1.0/docs/sources/_autosummary/_autosummary/lbfgsb.base.display_start.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+lbfgsb.base.display\_start
+==========================
+
+.. currentmodule:: lbfgsb.base
+
+.. autofunction:: display_start

lbfgsb-0.1.0/docs/sources/_autosummary/_autosummary/lbfgsb.base.get_bounds.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+lbfgsb.base.get\_bounds
+=======================
+
+.. currentmodule:: lbfgsb.base
+
+.. autofunction:: get_bounds

lbfgsb-0.1.0/docs/sources/_autosummary/_autosummary/lbfgsb.base.projgr.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+lbfgsb.base.projgr
+==================
+
+.. currentmodule:: lbfgsb.base
+
+.. autofunction:: projgr

lbfgsb-0.1.0/docs/sources/_autosummary/_autosummary/lbfgsb.base.projgr_ens.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+lbfgsb.base.projgr\_ens
+=======================
+
+.. currentmodule:: lbfgsb.base
+
+.. autofunction:: projgr_ens

lbfgsb-0.1.0/docs/sources/_autosummary/_autosummary/lbfgsb.bfgsmats.bmv.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+lbfgsb.bfgsmats.bmv
+===================
+
+.. currentmodule:: lbfgsb.bfgsmats
+
+.. autofunction:: bmv

lbfgsb-0.1.0/docs/sources/_autosummary/_autosummary/lbfgsb.bfgsmats.form_invMfactors.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+lbfgsb.bfgsmats.form\_invMfactors
+=================================
+
+.. currentmodule:: lbfgsb.bfgsmats
+
+.. autofunction:: form_invMfactors