Updated documentation and version number

Author: lindonroberts

dfols/__init__.py

@@ -39,7 +39,7 @@
 from __future__ import absolute_import, division, print_function, unicode_literals
 
 # DFO-LS version
-__version__ = '1.5.3'
+__version__ = '1.5.4'
 
 # Main solver & exit flags
 from .solver import *

docs/build/doctrees/environment.pickle

@@ -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: e27aac59f14e76a4142e0b9f9d374216
+config: 412cd91ff985b9489bd71148f8919cdf
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/doctrees/history.doctree

@@ -79,3 +79,7 @@ Version 1.5.2 (28 Oct 2024)
 Version 1.5.3 (30 Oct 2024)
 ---------------------------
 * Bugfix when starting solver at problem minimizer (bug introduced in v1.5.1)
+
+Version 1.5.4 (11 Feb 2025)
+---------------------------
+* Add ability to save/load results to/from a dictionary

docs/build/doctrees/index.doctree

@@ -67,6 +67,30 @@ These variables are defined in the :code:`soln` object, so can be accessed with,
       if soln.flag == soln.EXIT_SUCCESS:
           print("Success!")
 
+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.
+For example, to save the results to a JSON file, you may use
+
+  .. code-block:: python
+  
+      import json
+      soln_dict = soln.to_dict()  # convert soln to serializable dict object
+      with open("dfols_results.json", 'w') as f:
+          json.dump(soln_dict, f, indent=2)
+
+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`.
+
+To load results from a JSON file and convert to a solution object, you may use
+
+  .. code-block:: python
+  
+      import json
+      soln_dict = None
+      with open("dfols_results.json") as f:
+          soln_dict = json.load(f)  # read JSON into dict
+      soln = dfols.OptimResults.from_dict(soln_dict)  # convert to DFO-LS results object
+      print(soln)
+
+
 Optional Arguments
 ------------------
 The :code:`solve` function has several optional arguments which the user may provide:

docs/build/doctrees/userguide.doctree

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.5.3',
+    VERSION: '1.5.4',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

docs/build/html/.buildinfo

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Advanced Usage &mdash; DFO-LS v1.5.3 documentation</title>
+  <title>Advanced Usage &mdash; DFO-LS v1.5.4 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=d75fd82e"></script>
+        <script src="_static/documentation_options.js?v=1cd648e3"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
@@ -38,7 +38,7 @@
             DFO-LS
           </a>
               <div class="version">
-                1.5.3
+                1.5.4
               </div>
 <div role="search">
   <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
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2017-2024, Lindon Roberts.</p>
+    <p>&#169; Copyright 2017-2025, Lindon Roberts.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a