DFO-LS 1.3.0__tar.gz → 1.4.1__tar.gz

DFO-LS-1.4.1/DFO_LS.egg-info/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.1
+Name: DFO-LS
+Version: 1.4.1
+Summary: A flexible derivative-free solver for (bound constrained) nonlinear least-squares minimization
+Author-email: Lindon Roberts <lindon.roberts@sydney.edu.au>
+Maintainer-email: Lindon Roberts <lindon.roberts@sydney.edu.au>
+License: GPL-3.0-or-later
+Project-URL: Homepage, https://github.com/numericalalgorithmsgroup/dfols
+Project-URL: Download, https://github.com/numericalalgorithmsgroup/dfols/releases/
+Project-URL: Bug Tracker, https://github.com/numericalalgorithmsgroup/dfols/issues/
+Project-URL: Documentation, https://numericalalgorithmsgroup.github.io/dfols/
+Project-URL: Source Code, https://github.com/numericalalgorithmsgroup/dfols
+Keywords: mathematics,optimization,least squares,derivative free optimization,nonlinear least squares
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Framework :: IPython
+Classifier: Framework :: Jupyter
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: setuptools
+Requires-Dist: numpy
+Requires-Dist: scipy>=1.11
+Requires-Dist: pandas
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: Sphinx; extra == "dev"
+Requires-Dist: sphinx-rtd-theme; extra == "dev"
+Provides-Extra: trustregion
+Requires-Dist: trustregion>=1.1; extra == "trustregion"
+
+===================================================
+DFO-LS: Derivative-Free Optimizer for Least-Squares
+===================================================
+
+.. image::  https://github.com/numericalalgorithmsgroup/dfols/actions/workflows/python_testing.yml/badge.svg
+   :target: https://github.com/numericalalgorithmsgroup/dfols/actions
+   :alt: Build Status
+
+.. image::  https://img.shields.io/badge/License-GPL%20v3-blue.svg
+   :target: https://www.gnu.org/licenses/gpl-3.0
+   :alt: GNU GPL v3 License
+
+.. image:: https://img.shields.io/pypi/v/DFO-LS.svg
+   :target: https://pypi.python.org/pypi/DFO-LS
+   :alt: Latest PyPI version
+
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.2630426.svg
+   :target: https://doi.org/10.5281/zenodo.2630426
+   :alt: DOI:10.5281/zenodo.2630426
+   
+.. image:: https://static.pepy.tech/personalized-badge/dfo-ls?period=total&units=international_system&left_color=black&right_color=green&left_text=Downloads
+   :target: https://pepy.tech/project/dfo-ls
+   :alt: Total downloads
+
+DFO-LS is a flexible package for solving nonlinear least-squares minimization, without requiring derivatives of the objective. It is particularly useful when evaluations of the objective function are expensive and/or noisy. DFO-LS is more flexible version of `DFO-GN <https://github.com/numericalalgorithmsgroup/dfogn>`_.
+
+This is an implementation of the algorithm from our paper: C. Cartis, J. Fiala, B. Marteau and L. Roberts, `Improving the Flexibility and Robustness of Model-Based Derivative-Free Optimization Solvers <https://doi.org/10.1145/3338517>`_, *ACM Transactions on Mathematical Software*, 45:3 (2019), pp. 32:1-32:41 [`preprint <https://arxiv.org/abs/1804.00154>`_]. For reproducibility of all figures in this paper, please feel free to contact the authors. 
+
+If you are interested in solving general optimization problems (without a least-squares structure), you may wish to try `Py-BOBYQA <https://github.com/numericalalgorithmsgroup/pybobyqa>`_, which has many of the same features as DFO-LS.
+
+Documentation
+-------------
+See manual.pdf or `here <https://numericalalgorithmsgroup.github.io/dfols/>`_.
+
+Citation
+--------
+If you use DFO-LS in a paper, please cite:
+
+Cartis, C., Fiala, J., Marteau, B. and Roberts, L., `Improving the Flexibility and Robustness of Model-Based Derivative-Free Optimization Solvers <https://doi.org/10.1145/3338517>`_, *ACM Transactions on Mathematical Software*, 45:3 (2019), pp. 32:1-32:41.
+
+If you use DFO-LS for problems with constraints, including bound constraints, please also cite:
+
+Hough, M. and Roberts, L., `Model-Based Derivative-Free Methods for Convex-Constrained Optimization <https://doi.org/10.1137/21M1460971>`_, *SIAM Journal on Optimization*, 21:4 (2022), pp. 2552-2579.
+
+Requirements
+------------
+DFO-LS requires the following software to be installed:
+
+* Python 3.9 or higher (http://www.python.org/)
+
+Additionally, the following python packages should be installed (these will be installed automatically if using *pip*, see `Installation using pip`_):
+
+* NumPy (http://www.numpy.org/)
+* SciPy version 1.11 or higher (http://www.scipy.org/)
+* Pandas (http://pandas.pydata.org/)
+
+**Optional package:** DFO-LS versions 1.2 and higher also support the `trustregion <https://github.com/lindonroberts/trust-region>`_ package for fast trust-region subproblem solutions. To install this, make sure you have a Fortran compiler (e.g. `gfortran <https://gcc.gnu.org/wiki/GFortran>`_) and NumPy installed, then run :code:`pip install trustregion`. You do not have to have trustregion installed for DFO-LS to work, and it is not installed by default.
+
+Installation using conda
+------------------------
+DFO-LS can be directly installed in Anaconda environments using `conda-forge <https://anaconda.org/conda-forge/dfo-ls>`_:
+
+.. code-block:: bash
+
+    $ conda install -c conda-forge dfo-ls
+
+Installation using pip
+----------------------
+For easy installation, use `pip <http://www.pip-installer.org/>`_ as root:
+
+.. code-block:: bash
+
+    $ [sudo] pip install DFO-LS
+
+or alternatively *easy_install*:
+
+.. code-block:: bash
+
+    $ [sudo] easy_install DFO-LS
+
+If you do not have root privileges or you want to install DFO-LS for your private use, you can use:
+
+.. code-block:: bash
+
+    $ pip install --user DFO-LS
+
+which will install DFO-LS in your home directory.
+
+Note that if an older install of DFO-LS is present on your system you can use:
+
+.. code-block:: bash
+
+    $ [sudo] pip install --upgrade DFO-LS
+
+to upgrade DFO-LS to the latest version.
+
+Manual installation
+-------------------
+Alternatively, you can download the source code from `Github <https://github.com/numericalalgorithmsgroup/dfols>`_ and unpack as follows:
+
+ .. code-block:: bash
+
+    $ git clone https://github.com/numericalalgorithmsgroup/dfols
+    $ cd dfols
+
+DFO-LS is written in pure Python and requires no compilation. It can be installed using:
+
+ .. code-block:: bash
+
+    $ [sudo] pip install .
+
+If you do not have root privileges or you want to install DFO-LS for your private use, you can use:
+
+ .. code-block:: bash
+
+    $ pip install --user .
+
+instead.
+
+To upgrade DFO-LS to the latest version, navigate to the top-level directory (i.e. the one containing :code:`pyproject.toml`) and rerun the installation using :code:`pip`, as above:
+
+ .. code-block:: bash
+
+    $ git pull
+    $ [sudo] pip install .  # with admin privileges
+
+Testing
+-------
+If you installed DFO-LS manually, you can test your installation using the pytest package:
+
+ .. code-block:: bash
+
+    $ pip install pytest
+    $ python -m pytest --pyargs dfols
+
+Alternatively, the HTML documentation provides some simple examples of how to run DFO-LS.
+
+Examples
+--------
+Examples of how to run DFO-LS are given in the `documentation <https://numericalalgorithmsgroup.github.io/dfols/>`_, and the `examples <https://github.com/numericalalgorithmsgroup/dfols/tree/master/examples>`_ directory in Github.
+
+Uninstallation
+--------------
+If DFO-LS was installed using *pip* you can uninstall as follows:
+
+ .. code-block:: bash
+
+    $ [sudo] pip uninstall DFO-LS
+
+If DFO-LS was installed manually you have to remove the installed files by hand (located in your python site-packages directory).
+
+Bugs
+----
+Please report any bugs using `GitHub's issue tracker <https://github.com/numericalalgorithmsgroup/dfols/issues>`_.
+
+License
+-------
+This algorithm is released under the GNU GPL license. Please `contact NAG <http://www.nag.com/content/worldwide-contact-information>`_ for alternative licensing.

{DFO-LS-1.3.0 → DFO-LS-1.4.1}/DFO_LS.egg-info/SOURCES.txt

@@ -1,11 +1,12 @@
+LICENSE.txt
+MANIFEST.in
 README.rst
-setup.py
+pyproject.toml
 DFO_LS.egg-info/PKG-INFO
 DFO_LS.egg-info/SOURCES.txt
 DFO_LS.egg-info/dependency_links.txt
 DFO_LS.egg-info/requires.txt
 DFO_LS.egg-info/top_level.txt
-DFO_LS.egg-info/zip-safe
 dfols/__init__.py
 dfols/controller.py
 dfols/diagnostic_info.py
@@ -14,5 +15,4 @@ dfols/model.py
 dfols/params.py
 dfols/solver.py
 dfols/trust_region.py
-dfols/util.py
-dfols/version.py
+dfols/util.py

DFO-LS-1.4.1/DFO_LS.egg-info/requires.txt

@@ -0,0 +1,12 @@
+setuptools
+numpy
+scipy>=1.11
+pandas
+
+[dev]
+pytest
+Sphinx
+sphinx-rtd-theme
+
+[trustregion]
+trustregion>=1.1