Skip to content

Commit

Permalink
Minor version increment: make trustregion dependency optional
Browse files Browse the repository at this point in the history
  • Loading branch information
lindonroberts committed Feb 12, 2020
1 parent 454e5a9 commit 1267e69
Show file tree
Hide file tree
Showing 42 changed files with 171 additions and 151 deletions.
4 changes: 1 addition & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,14 @@ Requirements
DFO-LS requires the following software to be installed:

* Python 2.7 or Python 3 (http://www.python.org/)
* Fortran compiler (e.g. `gfortran <https://gcc.gnu.org/wiki/GFortran>`_), required by the `trustregion <https://github.com/lindonroberts/trust-region>`_ package.

Additionally, the following python packages should be installed (these will be installed automatically if using *pip*, see `Installation using pip`_):

* NumPy 1.11 or higher (http://www.numpy.org/)
* SciPy 0.18 or higher (http://www.scipy.org/)
* Pandas 0.17 or higher (http://pandas.pydata.org/)
* trustregion 1.1 or higher (https://github.com/lindonroberts/trust-region)

**Warning:** the trustregion package requires NumPy to already be installed. Please install NumPy before following the installation instructions below. This applies to DFO-LS versions 1.2 and higher.
**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 pip
----------------------
Expand Down
2 changes: 1 addition & 1 deletion dfols/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@
"""

__version__ = '1.2'
__version__ = '1.2.1'
Binary file modified docs/build/doctrees/advanced.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/diagnostic.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/history.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/info.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/install.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/userguide.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 925451d78dcb942ee18dd13a268c82ac
config: f5dff05cecdcf326084b18a76e7c59c0
tags: 645f666f9bcd5a90fca523b33c5a78b7
5 changes: 5 additions & 0 deletions docs/build/html/_sources/history.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,8 @@ Version 1.2 (12 Feb 2020)
* Don't adjust starting point if it is close to the bounds (as long as it is feasible).
* Option to stop default logging behavior and/or enable per-iteration printing.
* Bugfix: correctly handle 1-sided bounds as inputs, avoid divide-by-zero warnings when auto-detecting restarts.

Version 1.2.1 (13 Feb 2020)
---------------------------
* Make the use of the `trustregion <https://github.com/lindonroberts/trust-region>`_ package optional, not installed by default.

2 changes: 1 addition & 1 deletion docs/build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization

**Date:** |today|

**Author:** `Lindon Roberts <lindon.roberts@maths.ox.ac.uk>`_
**Author:** `Lindon Roberts <lindon.roberts@anu.edu.au>`_

DFO-LS is a flexible package for finding local solutions to nonlinear least-squares minimization problems (with optional bound constraints), without requiring any derivatives of the objective. DFO-LS stands for Derivative-Free Optimizer for Least-Squares.

Expand Down
4 changes: 1 addition & 3 deletions docs/build/html/_sources/install.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,14 @@ Requirements
DFO-LS requires the following software to be installed:

* Python 2.7 or Python 3 (http://www.python.org/)
* Fortran compiler (e.g. `gfortran <https://gcc.gnu.org/wiki/GFortran>`_), required by the `trustregion <https://github.com/lindonroberts/trust-region>`_ package.

Additionally, the following python packages should be installed (these will be installed automatically if using *pip*, see `Installation using pip`_):

* NumPy 1.11 or higher (http://www.numpy.org/)
* SciPy 0.18 or higher (http://www.scipy.org/)
* Pandas 0.17 or higher (http://pandas.pydata.org/)
* trustregion 1.1 or higher (https://github.com/lindonroberts/trust-region)

**Warning:** the trustregion package requires NumPy to already be installed. Please install NumPy before following the installation instructions below. This applies to DFO-LS versions 1.2 and higher.
**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 pip
----------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.2',
VERSION: '1.2.1',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/advanced.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Advanced Usage &mdash; DFO-LS v1.2 documentation</title>
<title>Advanced Usage &mdash; DFO-LS v1.2.1 documentation</title>



Expand Down Expand Up @@ -61,7 +61,7 @@


<div class="version">
1.2
1.2.1
</div>


Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/diagnostic.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Diagnostic Information &mdash; DFO-LS v1.2 documentation</title>
<title>Diagnostic Information &mdash; DFO-LS v1.2.1 documentation</title>



Expand Down Expand Up @@ -61,7 +61,7 @@


<div class="version">
1.2
1.2.1
</div>


Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Index &mdash; DFO-LS v1.2 documentation</title>
<title>Index &mdash; DFO-LS v1.2.1 documentation</title>



Expand Down Expand Up @@ -60,7 +60,7 @@


<div class="version">
1.2
1.2.1
</div>


Expand Down
11 changes: 9 additions & 2 deletions docs/build/html/history.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Version History &mdash; DFO-LS v1.2 documentation</title>
<title>Version History &mdash; DFO-LS v1.2.1 documentation</title>



Expand Down Expand Up @@ -60,7 +60,7 @@


<div class="version">
1.2
1.2.1
</div>


Expand Down Expand Up @@ -98,6 +98,7 @@
<li class="toctree-l2"><a class="reference internal" href="#version-1-1-16-jan-2019">Version 1.1 (16 Jan 2019)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#version-1-1-1-5-apr-2019">Version 1.1.1 (5 Apr 2019)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#version-1-2-12-feb-2020">Version 1.2 (12 Feb 2020)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#version-1-2-1-13-feb-2020">Version 1.2.1 (13 Feb 2020)</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -211,6 +212,12 @@ <h2>Version 1.2 (12 Feb 2020)<a class="headerlink" href="#version-1-2-12-feb-202
<li><p>Bugfix: correctly handle 1-sided bounds as inputs, avoid divide-by-zero warnings when auto-detecting restarts.</p></li>
</ul>
</div>
<div class="section" id="version-1-2-1-13-feb-2020">
<h2>Version 1.2.1 (13 Feb 2020)<a class="headerlink" href="#version-1-2-1-13-feb-2020" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Make the use of the <a class="reference external" href="https://github.com/lindonroberts/trust-region">trustregion</a> package optional, not installed by default.</p></li>
</ul>
</div>
</div>


Expand Down
11 changes: 6 additions & 5 deletions docs/build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization &mdash; DFO-LS v1.2 documentation</title>
<title>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization &mdash; DFO-LS v1.2.1 documentation</title>



Expand Down Expand Up @@ -60,7 +60,7 @@


<div class="version">
1.2
1.2.1
</div>


Expand Down Expand Up @@ -158,9 +158,9 @@

<div class="section" id="dfo-ls-derivative-free-optimizer-for-least-squares-minimization">
<h1>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization<a class="headerlink" href="#dfo-ls-derivative-free-optimizer-for-least-squares-minimization" title="Permalink to this headline"></a></h1>
<p><strong>Release:</strong> 1.2</p>
<p><strong>Date:</strong> 12 February 2020</p>
<p><strong>Author:</strong> <a class="reference external" href="mailto:lindon&#46;roberts&#37;&#52;&#48;maths&#46;ox&#46;ac&#46;uk">Lindon Roberts</a></p>
<p><strong>Release:</strong> 1.2.1</p>
<p><strong>Date:</strong> 13 February 2020</p>
<p><strong>Author:</strong> <a class="reference external" href="mailto:lindon&#46;roberts&#37;&#52;&#48;anu&#46;edu&#46;au">Lindon Roberts</a></p>
<p>DFO-LS is a flexible package for finding local solutions to nonlinear least-squares minimization problems (with optional bound constraints), without requiring any derivatives of the objective. DFO-LS stands for Derivative-Free Optimizer for Least-Squares.</p>
<p>That is, DFO-LS solves</p>
<div class="math notranslate nohighlight">
Expand Down Expand Up @@ -231,6 +231,7 @@ <h1>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization<a class="he
<li class="toctree-l2"><a class="reference internal" href="history.html#version-1-1-16-jan-2019">Version 1.1 (16 Jan 2019)</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html#version-1-1-1-5-apr-2019">Version 1.1.1 (5 Apr 2019)</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html#version-1-2-12-feb-2020">Version 1.2 (12 Feb 2020)</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html#version-1-2-1-13-feb-2020">Version 1.2.1 (13 Feb 2020)</a></li>
</ul>
</li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/info.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Overview &mdash; DFO-LS v1.2 documentation</title>
<title>Overview &mdash; DFO-LS v1.2.1 documentation</title>



Expand Down Expand Up @@ -61,7 +61,7 @@


<div class="version">
1.2
1.2.1
</div>


Expand Down
8 changes: 3 additions & 5 deletions docs/build/html/install.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Installing DFO-LS &mdash; DFO-LS v1.2 documentation</title>
<title>Installing DFO-LS &mdash; DFO-LS v1.2.1 documentation</title>



Expand Down Expand Up @@ -61,7 +61,7 @@


<div class="version">
1.2
1.2.1
</div>


Expand Down Expand Up @@ -171,16 +171,14 @@ <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to t
<p>DFO-LS requires the following software to be installed:</p>
<ul class="simple">
<li><p>Python 2.7 or Python 3 (<a class="reference external" href="http://www.python.org/">http://www.python.org/</a>)</p></li>
<li><p>Fortran compiler (e.g. <a class="reference external" href="https://gcc.gnu.org/wiki/GFortran">gfortran</a>), required by the <a class="reference external" href="https://github.com/lindonroberts/trust-region">trustregion</a> package.</p></li>
</ul>
<p>Additionally, the following python packages should be installed (these will be installed automatically if using <em>pip</em>, see <a class="reference internal" href="#installation-using-pip">Installation using pip</a>):</p>
<ul class="simple">
<li><p>NumPy 1.11 or higher (<a class="reference external" href="http://www.numpy.org/">http://www.numpy.org/</a>)</p></li>
<li><p>SciPy 0.18 or higher (<a class="reference external" href="http://www.scipy.org/">http://www.scipy.org/</a>)</p></li>
<li><p>Pandas 0.17 or higher (<a class="reference external" href="http://pandas.pydata.org/">http://pandas.pydata.org/</a>)</p></li>
<li><p>trustregion 1.1 or higher (<a class="reference external" href="https://github.com/lindonroberts/trust-region">https://github.com/lindonroberts/trust-region</a>)</p></li>
</ul>
<p><strong>Warning:</strong> the trustregion package requires NumPy to already be installed. Please install NumPy before following the installation instructions below. This applies to DFO-LS versions 1.2 and higher.</p>
<p><strong>Optional package:</strong> DFO-LS versions 1.2 and higher also support the <a class="reference external" href="https://github.com/lindonroberts/trust-region">trustregion</a> package for fast trust-region subproblem solutions. To install this, make sure you have a Fortran compiler (e.g. <a class="reference external" href="https://gcc.gnu.org/wiki/GFortran">gfortran</a>) and NumPy installed, then run <code class="code docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">trustregion</span></code>. You do not have to have trustregion installed for DFO-LS to work, and it is not installed by default.</p>
</div>
<div class="section" id="installation-using-pip">
<h2>Installation using pip<a class="headerlink" href="#installation-using-pip" title="Permalink to this headline"></a></h2>
Expand Down
Binary file modified docs/build/html/objects.inv
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/build/html/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Search &mdash; DFO-LS v1.2 documentation</title>
<title>Search &mdash; DFO-LS v1.2.1 documentation</title>



Expand Down Expand Up @@ -60,7 +60,7 @@


<div class="version">
1.2
1.2.1
</div>


Expand Down
Loading

0 comments on commit 1267e69

Please sign in to comment.