Skip to content

Commit 06a8c7c

Browse files
lindonrobertslindonroberts
committed
Updated documentation and version number
1 parent 4d163a3 commit 06a8c7c

31 files changed

+226
-98
lines changed

‎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.5.3'
42+
__version__ = '1.5.4'
4343

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

‎docs/build/doctrees/environment.pickle

6.43 KB
Binary file not shown.

‎docs/build/doctrees/history.doctree

724 Bytes
Binary file not shown.

‎docs/build/doctrees/index.doctree

1 Byte
Binary file not shown.

‎docs/build/doctrees/userguide.doctree

3.65 KB
Binary file not shown.

‎docs/build/html/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: e27aac59f14e76a4142e0b9f9d374216
3+
config: 412cd91ff985b9489bd71148f8919cdf
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/build/html/_sources/history.rst.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,7 @@ Version 1.5.2 (28 Oct 2024)
7979
Version 1.5.3 (30 Oct 2024)
8080
---------------------------
8181
* Bugfix when starting solver at problem minimizer (bug introduced in v1.5.1)
82+
83+
Version 1.5.4 (11 Feb 2025)
84+
---------------------------
85+
* Add ability to save/load results to/from a dictionary

‎docs/build/html/_sources/userguide.rst.txt

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,30 @@ These variables are defined in the :code:`soln` object, so can be accessed with,
6767
if soln.flag == soln.EXIT_SUCCESS:
6868
print("Success!")
6969
70+
In newer versions DFO-LS (v1.5.4 onwards), the results object can be converted to, or loaded from, a serialized Python dictionary. This allows the results to be saved as a JSON file.
71+
For example, to save the results to a JSON file, you may use
72+
73+
.. code-block:: python
74+
75+
import json
76+
soln_dict = soln.to_dict() # convert soln to serializable dict object
77+
with open("dfols_results.json", 'w') as f:
78+
json.dump(soln_dict, f, indent=2)
79+
80+
The :code:`to_dict()` function takes an optional boolean, :code:`to_dict(replace_nan=True)`. If :code:`replace_nan` is :code:`True`, any NaN values in the results object are converted to :code:`None`.
81+
82+
To load results from a JSON file and convert to a solution object, you may use
83+
84+
.. code-block:: python
85+
86+
import json
87+
soln_dict = None
88+
with open("dfols_results.json") as f:
89+
soln_dict = json.load(f) # read JSON into dict
90+
soln = dfols.OptimResults.from_dict(soln_dict) # convert to DFO-LS results object
91+
print(soln)
92+
93+
7094
Optional Arguments
7195
------------------
7296
The :code:`solve` function has several optional arguments which the user may provide:

‎docs/build/html/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '1.5.3',
2+
VERSION: '1.5.4',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

‎docs/build/html/advanced.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Advanced Usage &mdash; DFO-LS v1.5.3 documentation</title>
7+
<title>Advanced Usage &mdash; DFO-LS v1.5.4 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
1010

@@ -15,7 +15,7 @@
1515

1616
<script src="_static/jquery.js?v=5d32c60e"></script>
1717
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
18-
<script src="_static/documentation_options.js?v=d75fd82e"></script>
18+
<script src="_static/documentation_options.js?v=1cd648e3"></script>
1919
<script src="_static/doctools.js?v=888ff710"></script>
2020
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
2121
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
@@ -38,7 +38,7 @@
3838
DFO-LS
3939
</a>
4040
<div class="version">
41-
1.5.3
41+
1.5.4
4242
</div>
4343
<div role="search">
4444
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -276,7 +276,7 @@ <h2>References<a class="headerlink" href="#references" title="Link to this headi
276276
<hr/>
277277

278278
<div role="contentinfo">
279-
<p>&#169; Copyright 2017-2024, Lindon Roberts.</p>
279+
<p>&#169; Copyright 2017-2025, Lindon Roberts.</p>
280280
</div>
281281

282282
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/build/html/contributors.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Contributors &mdash; DFO-LS v1.5.3 documentation</title>
7+
<title>Contributors &mdash; DFO-LS v1.5.4 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
1010

@@ -15,7 +15,7 @@
1515

1616
<script src="_static/jquery.js?v=5d32c60e"></script>
1717
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
18-
<script src="_static/documentation_options.js?v=d75fd82e"></script>
18+
<script src="_static/documentation_options.js?v=1cd648e3"></script>
1919
<script src="_static/doctools.js?v=888ff710"></script>
2020
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
2121
<script src="_static/js/theme.js"></script>
@@ -36,7 +36,7 @@
3636
DFO-LS
3737
</a>
3838
<div class="version">
39-
1.5.3
39+
1.5.4
4040
</div>
4141
<div role="search">
4242
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -113,7 +113,7 @@ <h2>Contributors<a class="headerlink" href="#id1" title="Link to this heading">
113113
<hr/>
114114

115115
<div role="contentinfo">
116-
<p>&#169; Copyright 2017-2024, Lindon Roberts.</p>
116+
<p>&#169; Copyright 2017-2025, Lindon Roberts.</p>
117117
</div>
118118

119119
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/build/html/diagnostic.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Diagnostic Information &mdash; DFO-LS v1.5.3 documentation</title>
7+
<title>Diagnostic Information &mdash; DFO-LS v1.5.4 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
1010

@@ -15,7 +15,7 @@
1515

1616
<script src="_static/jquery.js?v=5d32c60e"></script>
1717
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
18-
<script src="_static/documentation_options.js?v=d75fd82e"></script>
18+
<script src="_static/documentation_options.js?v=1cd648e3"></script>
1919
<script src="_static/doctools.js?v=888ff710"></script>
2020
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
2121
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
@@ -38,7 +38,7 @@
3838
DFO-LS
3939
</a>
4040
<div class="version">
41-
1.5.3
41+
1.5.4
4242
</div>
4343
<div role="search">
4444
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -170,7 +170,7 @@ <h2>Algorithm Progress<a class="headerlink" href="#algorithm-progress" title="Li
170170
<hr/>
171171

172172
<div role="contentinfo">
173-
<p>&#169; Copyright 2017-2024, Lindon Roberts.</p>
173+
<p>&#169; Copyright 2017-2025, Lindon Roberts.</p>
174174
</div>
175175

176176
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/build/html/genindex.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>Index &mdash; DFO-LS v1.5.3 documentation</title>
6+
<title>Index &mdash; DFO-LS v1.5.4 documentation</title>
77
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
88
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
99

@@ -14,7 +14,7 @@
1414

1515
<script src="_static/jquery.js?v=5d32c60e"></script>
1616
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17-
<script src="_static/documentation_options.js?v=d75fd82e"></script>
17+
<script src="_static/documentation_options.js?v=1cd648e3"></script>
1818
<script src="_static/doctools.js?v=888ff710"></script>
1919
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
2020
<script src="_static/js/theme.js"></script>
@@ -34,7 +34,7 @@
3434
DFO-LS
3535
</a>
3636
<div class="version">
37-
1.5.3
37+
1.5.4
3838
</div>
3939
<div role="search">
4040
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -93,7 +93,7 @@ <h1 id="index">Index</h1>
9393
<hr/>
9494

9595
<div role="contentinfo">
96-
<p>&#169; Copyright 2017-2024, Lindon Roberts.</p>
96+
<p>&#169; Copyright 2017-2025, Lindon Roberts.</p>
9797
</div>
9898

9999
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/build/html/history.html

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Version History &mdash; DFO-LS v1.5.3 documentation</title>
7+
<title>Version History &mdash; DFO-LS v1.5.4 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
1010

@@ -15,7 +15,7 @@
1515

1616
<script src="_static/jquery.js?v=5d32c60e"></script>
1717
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
18-
<script src="_static/documentation_options.js?v=d75fd82e"></script>
18+
<script src="_static/documentation_options.js?v=1cd648e3"></script>
1919
<script src="_static/doctools.js?v=888ff710"></script>
2020
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
2121
<script src="_static/js/theme.js"></script>
@@ -37,7 +37,7 @@
3737
DFO-LS
3838
</a>
3939
<div class="version">
40-
1.5.3
40+
1.5.4
4141
</div>
4242
<div role="search">
4343
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -71,6 +71,7 @@
7171
<li class="toctree-l2"><a class="reference internal" href="#version-1-5-1-10-oct-2024">Version 1.5.1 (10 Oct 2024)</a></li>
7272
<li class="toctree-l2"><a class="reference internal" href="#version-1-5-2-28-oct-2024">Version 1.5.2 (28 Oct 2024)</a></li>
7373
<li class="toctree-l2"><a class="reference internal" href="#version-1-5-3-30-oct-2024">Version 1.5.3 (30 Oct 2024)</a></li>
74+
<li class="toctree-l2"><a class="reference internal" href="#version-1-5-4-11-feb-2025">Version 1.5.4 (11 Feb 2025)</a></li>
7475
</ul>
7576
</li>
7677
<li class="toctree-l1"><a class="reference internal" href="contributors.html">Contributors</a></li>
@@ -213,6 +214,12 @@ <h2>Version 1.5.3 (30 Oct 2024)<a class="headerlink" href="#version-1-5-3-30-oct
213214
<li><p>Bugfix when starting solver at problem minimizer (bug introduced in v1.5.1)</p></li>
214215
</ul>
215216
</section>
217+
<section id="version-1-5-4-11-feb-2025">
218+
<h2>Version 1.5.4 (11 Feb 2025)<a class="headerlink" href="#version-1-5-4-11-feb-2025" title="Link to this heading"></a></h2>
219+
<ul class="simple">
220+
<li><p>Add ability to save/load results to/from a dictionary</p></li>
221+
</ul>
222+
</section>
216223
</section>
217224

218225

@@ -226,7 +233,7 @@ <h2>Version 1.5.3 (30 Oct 2024)<a class="headerlink" href="#version-1-5-3-30-oct
226233
<hr/>
227234

228235
<div role="contentinfo">
229-
<p>&#169; Copyright 2017-2024, Lindon Roberts.</p>
236+
<p>&#169; Copyright 2017-2025, Lindon Roberts.</p>
230237
</div>
231238

232239
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/build/html/index.html

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization &mdash; DFO-LS v1.5.3 documentation</title>
7+
<title>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization &mdash; DFO-LS v1.5.4 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
1010

@@ -15,7 +15,7 @@
1515

1616
<script src="_static/jquery.js?v=5d32c60e"></script>
1717
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
18-
<script src="_static/documentation_options.js?v=d75fd82e"></script>
18+
<script src="_static/documentation_options.js?v=1cd648e3"></script>
1919
<script src="_static/doctools.js?v=888ff710"></script>
2020
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
2121
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
@@ -37,7 +37,7 @@
3737
DFO-LS
3838
</a>
3939
<div class="version">
40-
1.5.3
40+
1.5.4
4141
</div>
4242
<div role="search">
4343
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -84,8 +84,8 @@
8484

8585
<section id="dfo-ls-derivative-free-optimizer-for-least-squares-minimization">
8686
<h1>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization<a class="headerlink" href="#dfo-ls-derivative-free-optimizer-for-least-squares-minimization" title="Link to this heading"></a></h1>
87-
<p><strong>Release:</strong> 1.5.3</p>
88-
<p><strong>Date:</strong> 30 October 2024</p>
87+
<p><strong>Release:</strong> 1.5.4</p>
88+
<p><strong>Date:</strong> 11 February 2025</p>
8989
<p><strong>Author:</strong> <a class="reference external" href="https://lindonroberts.github.io/">Lindon Roberts</a></p>
9090
<p>DFO-LS is a flexible package for finding local solutions to nonlinear least-squares minimization problems (with optional regularizer and constraints), without requiring any derivatives of the objective. DFO-LS stands for Derivative-Free Optimizer for Least-Squares.</p>
9191
<p>That is, DFO-LS solves</p>
@@ -192,6 +192,7 @@ <h1>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization<a class="he
192192
<li class="toctree-l2"><a class="reference internal" href="history.html#version-1-5-1-10-oct-2024">Version 1.5.1 (10 Oct 2024)</a></li>
193193
<li class="toctree-l2"><a class="reference internal" href="history.html#version-1-5-2-28-oct-2024">Version 1.5.2 (28 Oct 2024)</a></li>
194194
<li class="toctree-l2"><a class="reference internal" href="history.html#version-1-5-3-30-oct-2024">Version 1.5.3 (30 Oct 2024)</a></li>
195+
<li class="toctree-l2"><a class="reference internal" href="history.html#version-1-5-4-11-feb-2025">Version 1.5.4 (11 Feb 2025)</a></li>
195196
</ul>
196197
</li>
197198
<li class="toctree-l1"><a class="reference internal" href="contributors.html">Contributors</a><ul>
@@ -217,7 +218,7 @@ <h2>Acknowledgements<a class="headerlink" href="#acknowledgements" title="Link t
217218
<hr/>
218219

219220
<div role="contentinfo">
220-
<p>&#169; Copyright 2017-2024, Lindon Roberts.</p>
221+
<p>&#169; Copyright 2017-2025, Lindon Roberts.</p>
221222
</div>
222223

223224
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/build/html/info.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Overview &mdash; DFO-LS v1.5.3 documentation</title>
7+
<title>Overview &mdash; DFO-LS v1.5.4 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
1010

@@ -15,7 +15,7 @@
1515

1616
<script src="_static/jquery.js?v=5d32c60e"></script>
1717
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
18-
<script src="_static/documentation_options.js?v=d75fd82e"></script>
18+
<script src="_static/documentation_options.js?v=1cd648e3"></script>
1919
<script src="_static/doctools.js?v=888ff710"></script>
2020
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
2121
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
@@ -38,7 +38,7 @@
3838
DFO-LS
3939
</a>
4040
<div class="version">
41-
1.5.3
41+
1.5.4
4242
</div>
4343
<div role="search">
4444
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -177,7 +177,7 @@ <h2>References<a class="headerlink" href="#references" title="Link to this headi
177177
<hr/>
178178

179179
<div role="contentinfo">
180-
<p>&#169; Copyright 2017-2024, Lindon Roberts.</p>
180+
<p>&#169; Copyright 2017-2025, Lindon Roberts.</p>
181181
</div>
182182

183183
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/build/html/install.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Installing DFO-LS &mdash; DFO-LS v1.5.3 documentation</title>
7+
<title>Installing DFO-LS &mdash; DFO-LS v1.5.4 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
1010

@@ -15,7 +15,7 @@
1515

1616
<script src="_static/jquery.js?v=5d32c60e"></script>
1717
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
18-
<script src="_static/documentation_options.js?v=d75fd82e"></script>
18+
<script src="_static/documentation_options.js?v=1cd648e3"></script>
1919
<script src="_static/doctools.js?v=888ff710"></script>
2020
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
2121
<script src="_static/js/theme.js"></script>
@@ -37,7 +37,7 @@
3737
DFO-LS
3838
</a>
3939
<div class="version">
40-
1.5.3
40+
1.5.4
4141
</div>
4242
<div role="search">
4343
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -188,7 +188,7 @@ <h2>Uninstallation<a class="headerlink" href="#uninstallation" title="Link to th
188188
<hr/>
189189

190190
<div role="contentinfo">
191-
<p>&#169; Copyright 2017-2024, Lindon Roberts.</p>
191+
<p>&#169; Copyright 2017-2025, Lindon Roberts.</p>
192192
</div>
193193

194194
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/build/html/objects.inv

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)