Skip to content

Commit b10c9d7

Browse files
committed
Update citation information and increment version number
1 parent 2476e63 commit b10c9d7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+2273
-1414
lines changed

README.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,19 +40,19 @@ Cartis, C., Fiala, J., Marteau, B. and Roberts, L., `Improving the Flexibility a
4040

4141
If you use DFO-LS for problems with constraints, including bound constraints, please also cite:
4242

43-
Hough, M. and Roberts, L., `Model-Based Derivative-Free Methods for Convex-Constrained Optimization <https://arxiv.org/abs/2111.05443>`_, *arXiv preprint arXiv:2111.05443*, (2021).
43+
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.
4444

4545
Requirements
4646
------------
4747
DFO-LS requires the following software to be installed:
4848

49-
* Python 2.7 or Python 3 (http://www.python.org/)
49+
* Python 3.9 or higher (http://www.python.org/)
5050

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

53-
* NumPy 1.11 or higher (http://www.numpy.org/)
54-
* SciPy 1.11 or higher (http://www.scipy.org/)
55-
* Pandas 0.17 or higher (http://pandas.pydata.org/)
53+
* NumPy (http://www.numpy.org/)
54+
* SciPy version 1.11 or higher (http://www.scipy.org/)
55+
* Pandas (http://pandas.pydata.org/)
5656

5757
**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.
5858

@@ -117,7 +117,7 @@ If you do not have root privileges or you want to install DFO-LS for your privat
117117
118118
instead.
119119

120-
To upgrade DFO-LS to the latest version, navigate to the top-level directory (i.e. the one containing :code:`setup.py`) and rerun the installation using :code:`pip`, as above:
120+
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:
121121

122122
.. code-block:: bash
123123
@@ -126,11 +126,12 @@ To upgrade DFO-LS to the latest version, navigate to the top-level directory (i.
126126
127127
Testing
128128
-------
129-
If you installed DFO-LS manually, you can test your installation by running:
129+
If you installed DFO-LS manually, you can test your installation using the pytest package:
130130

131131
.. code-block:: bash
132132
133-
$ python setup.py test
133+
$ pip install pytest
134+
$ python -m pytest --pyargs dfols
134135
135136
Alternatively, the HTML documentation provides some simple examples of how to run DFO-LS.
136137

@@ -150,7 +151,7 @@ If DFO-LS was installed manually you have to remove the installed files by hand
150151

151152
Bugs
152153
----
153-
Please report any bugs using GitHub's issue tracker.
154+
Please report any bugs using `GitHub's issue tracker <https://github.com/numericalalgorithmsgroup/dfols/issues>`_.
154155

155156
License
156157
-------

dfols/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
from __future__ import absolute_import, division, print_function, unicode_literals
4040

4141
# DFO-LS version
42-
__version__ = '1.4.0'
42+
__version__ = '1.4.1'
4343

4444
# Main solver & exit flags
4545
from .solver import *

docs/advanced.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Advanced Usage
22
==============
33
This section describes different optional user parameters available in DFO-LS.
44

5-
In the last section (:doc:`userguide`), we introduced :code:`dfols.solve()`, which has the optional input :code:`user_params`. This is a Python dictionary of user parameters. We will now go through the settings which can be changed in this way. More details are available in the papers [CFMR2018]_ and [HR2021]_.
5+
In the last section (:doc:`userguide`), we introduced :code:`dfols.solve()`, which has the optional input :code:`user_params`. This is a Python dictionary of user parameters. We will now go through the settings which can be changed in this way. More details are available in the papers [CFMR2018]_ and [HR2022]_.
66

77
The default values, used if no override is given, in some cases vary depending on whether :code:`objfun` has stochastic noise; that is, whether evaluating :code:`objfun(x)` several times at the same :code:`x` gives the same result or not. Whether or not this is the case is determined by the :code:`objfun_has_noise` input to :code:`dfols.solve()` (and not by inspecting :code:`objfun`, for instance).
88

@@ -119,5 +119,5 @@ References
119119
.. [CFMR2018]
120120
Coralia Cartis, Jan Fiala, Benjamin Marteau and Lindon 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>`_]
121121
122-
.. [HR2021]
123-
Hough, M. and Roberts, L., `Model-Based Derivative-Free Methods for Convex-Constrained Optimization <https://arxiv.org/abs/2111.05443>`_, *arXiv preprint arXiv:2111.05443*, (2021).
122+
.. [HR2022]
123+
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 [`preprint <https://arxiv.org/abs/2111.05443>`_].

docs/build/doctrees/advanced.doctree

797 Bytes
Binary file not shown.
16 Bytes
Binary file not shown.
16 Bytes
Binary file not shown.
5.95 KB
Binary file not shown.

docs/build/doctrees/history.doctree

1.04 KB
Binary file not shown.

docs/build/doctrees/index.doctree

837 Bytes
Binary file not shown.

docs/build/doctrees/info.doctree

797 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)