Updated installation instructions

numericalalgorithmsgroup · Feb 12, 2020 · 454e5a9 · 454e5a9
1 parent a902648
commit 454e5a9
Show file tree

Hide file tree

Showing 14 changed files with 101 additions and 85 deletions.
diff --git a/README.rst b/README.rst
@@ -46,6 +46,9 @@ Additionally, the following python packages should be installed (these will be i
 * 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.
 
 Installation using pip
 ----------------------

diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/install.doctree b/docs/build/doctrees/install.doctree
diff --git a/docs/build/html/_sources/install.rst.txt b/docs/build/html/_sources/install.rst.txt
@@ -13,6 +13,9 @@ Additionally, the following python packages should be installed (these will be i
 * 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.
 
 Installation using pip
 ----------------------

diff --git a/docs/build/html/install.html b/docs/build/html/install.html
@@ -178,7 +178,9 @@ <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to t
 <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>
 </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>

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
diff --git a/docs/build/latex/DFOLS.fdb_latexmk b/docs/build/latex/DFOLS.fdb_latexmk
@@ -1,10 +1,10 @@
 # Fdb version 3
-["makeindex DFOLS.idx"] 1533896586 "DFOLS.idx" "DFOLS.ind" "DFOLS" 1581508570
-  "DFOLS.idx" 1581508569 0 d41d8cd98f00b204e9800998ecf8427e ""
+["makeindex DFOLS.idx"] 1533896586 "DFOLS.idx" "DFOLS.ind" "DFOLS" 1581509750
+  "DFOLS.idx" 1581509750 0 d41d8cd98f00b204e9800998ecf8427e ""
   (generated)
   "DFOLS.ilg"
   "DFOLS.ind"
-["pdflatex"] 1581508569 "DFOLS.tex" "DFOLS.pdf" "DFOLS" 1581508570
+["pdflatex"] 1581509749 "DFOLS.tex" "DFOLS.pdf" "DFOLS" 1581509750
   "/etc/texmf/web2c/texmf.cnf" 1556127073 1101 af7716885e081ab43982cab7b4672c1a ""
   "/usr/share/texlive/texmf-dist/fonts/enc/dvips/base/8r.enc" 1165713224 4850 80dc9bab7f31fb78a000ccfed0e27cab ""
   "/usr/share/texlive/texmf-dist/fonts/map/fontname/texfonts.map" 1272929888 3287 e6b82fe08f5336d4d5ebc73fb1152e87 ""
@@ -165,22 +165,22 @@
   "/usr/share/texmf/web2c/texmf.cnf" 1503343927 31343 93828589fb0cea665e553ee5a17ad2d4 ""
   "/var/lib/texmf/fonts/map/pdftex/updmap/pdftex.map" 1556127139 1863403 f3ff9a4253bcb5fb9a9baaf0c572cb01 ""
   "/var/lib/texmf/web2c/pdftex/pdflatex.fmt" 1556127159 3854047 41d616fd6b0ec4ee30d5039a0cf48801 ""
-  "DFOLS.aux" 1581508569 11582 301043c01ea3382032845a942a9595e6 ""
+  "DFOLS.aux" 1581509750 11582 301043c01ea3382032845a942a9595e6 ""
   "DFOLS.ind" 1533896586 0 d41d8cd98f00b204e9800998ecf8427e "makeindex DFOLS.idx"
-  "DFOLS.out" 1581508569 8394 79ad965942e227c1e9bc996405ece3b5 ""
-  "DFOLS.tex" 1581508566 82653 f5fcc7e005cc8897f1d973d0a0364fea ""
-  "DFOLS.toc" 1581508569 4144 e547cdf6ac71953d726e6ede309997b0 ""
+  "DFOLS.out" 1581509750 8394 79ad965942e227c1e9bc996405ece3b5 ""
+  "DFOLS.tex" 1581509747 82981 6c92a6a238f621f57e674cc125649863 ""
+  "DFOLS.toc" 1581509750 4144 e547cdf6ac71953d726e6ede309997b0 ""
   "data_fitting.png" 1517839082 29893 211bb1c28ea25d47c8c0990fbf39c55c ""
   "footnotehyper-sphinx.sty" 1581508046 8888 1bbd7bdeae8c8bed1d10d551bddb1cc9 ""
   "sphinx.sty" 1581508046 81878 44d14f90f8cb22a202794c148df60b64 ""
-  "sphinxhighlight.sty" 1581508567 8137 93cbe0c10a29687032cb5b9b78b48dc2 ""
+  "sphinxhighlight.sty" 1581509748 8137 f17c301def8beecbe3e05eb36a4aee2e ""
   "sphinxmanual.cls" 1581508046 4236 124cd90deb92742b5d3922bfc2cd70c0 ""
-  "sphinxmessages.sty" 1581508568 745 3f5fcd6cdd7964ed608767954a8ced6f ""
+  "sphinxmessages.sty" 1581509749 745 3f5fcd6cdd7964ed608767954a8ced6f ""
   "sphinxmulticell.sty" 1581508046 14606 0b6edc2b1a83546ed92026d1f6a311b5 ""
   (generated)
   "DFOLS.idx"
   "DFOLS.toc"
-  "DFOLS.pdf"
   "DFOLS.out"
-  "DFOLS.log"
   "DFOLS.aux"
+  "DFOLS.pdf"
+  "DFOLS.log"
diff --git a/docs/build/latex/DFOLS.fls b/docs/build/latex/DFOLS.fls
@@ -273,7 +273,6 @@ INPUT /usr/share/texlive/texmf-dist/tex/latex/psnfss/t1pcr.fd
 INPUT /usr/share/texlive/texmf-dist/tex/latex/psnfss/t1pcr.fd
 INPUT /usr/share/texlive/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm
 INPUT /usr/share/texlive/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm
-INPUT /usr/share/texlive/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
 INPUT /usr/share/texlive/texmf-dist/fonts/vf/adobe/times/ptmr8c.vf
 INPUT /usr/share/texlive/texmf-dist/fonts/vf/adobe/times/ptmri8t.vf
 INPUT /usr/share/texlive/texmf-dist/fonts/tfm/adobe/times/ptmri8r.tfm
@@ -291,6 +290,7 @@ INPUT /usr/share/texlive/texmf-dist/fonts/tfm/adobe/courier/pcrb8r.tfm
 INPUT /usr/share/texlive/texmf-dist/tex/latex/psnfss/ts1pcr.fd
 INPUT /usr/share/texlive/texmf-dist/tex/latex/psnfss/ts1pcr.fd
 INPUT /usr/share/texlive/texmf-dist/fonts/tfm/adobe/courier/pcrr8c.tfm
+INPUT /usr/share/texlive/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
 INPUT /usr/share/texlive/texmf-dist/fonts/vf/adobe/courier/pcrr8c.vf
 INPUT /usr/share/texlive/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf
 INPUT /usr/share/texlive/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm

diff --git a/docs/build/latex/DFOLS.log b/docs/build/latex/DFOLS.log
@@ -1,4 +1,4 @@
-This is pdfTeX, Version 3.14159265-2.6-1.40.16 (TeX Live 2015/Debian) (preloaded format=pdflatex 2019.4.24)  12 FEB 2020 22:56
+This is pdfTeX, Version 3.14159265-2.6-1.40.16 (TeX Live 2015/Debian) (preloaded format=pdflatex 2019.4.24)  12 FEB 2020 23:15
 entering extended mode
  restricted \write18 enabled.
  %&-line parsing enabled.
@@ -1158,13 +1158,13 @@ LaTeX Font Info:    Try loading font information for TS1+ptm on input line 121.
 (/usr/share/texlive/texmf-dist/tex/latex/psnfss/ts1ptm.fd
 File: ts1ptm.fd 2001/06/04 font definitions for TS1/ptm.
 )
-LaTeX Font Info:    Try loading font information for T1+pcr on input line 147.
+LaTeX Font Info:    Try loading font information for T1+pcr on input line 152.
 
 (/usr/share/texlive/texmf-dist/tex/latex/psnfss/t1pcr.fd
 File: t1pcr.fd 2001/06/04 font definitions for T1/pcr.
 ) [3]
 LaTeX Font Info:    Font shape `T1/pcr/m/it' in size <9> not available
-(Font)              Font shape `T1/pcr/m/sl' tried instead on input line 216.
+(Font)              Font shape `T1/pcr/m/sl' tried instead on input line 221.
  [4]
 Chapter 2.
 [5
@@ -1175,44 +1175,44 @@ Chapter 2.
 Chapter 3.
 [9]
 LaTeX Font Info:    Font shape `T1/pcr/bx/n' in size <9> not available
-(Font)              Font shape `T1/pcr/b/n' tried instead on input line 426.
+(Font)              Font shape `T1/pcr/b/n' tried instead on input line 431.
  [10]
 LaTeX Font Info:    Try loading font information for TS1+pcr on input line 1.
  (/usr/share/texlive/texmf-dist/tex/latex/psnfss/ts1pcr.fd
 File: ts1pcr.fd 2001/06/04 font definitions for TS1/pcr.
 ) [11]
 [12] [13]
-Overfull \vbox (2.68167pt too high) detected at line 717
+Overfull \vbox (2.68167pt too high) detected at line 722
  []
 
-[14] [15] <data_fitting.png, id=388, 524.6802pt x 403.2666pt>
+[14] [15] <data_fitting.png, id=389, 524.6802pt x 403.2666pt>
 File: data_fitting.png Graphic file (type png)
 
 <use data_fitting.png>
-Package pdftex.def Info: data_fitting.png used on input line 817.
+Package pdftex.def Info: data_fitting.png used on input line 822.
 (pdftex.def)             Requested size: 352.31625pt x 270.79639pt.
  [16]
-Overfull \vbox (2.92438pt too high) detected at line 877
+Overfull \vbox (2.92438pt too high) detected at line 882
  []
 
 [17 <./data_fitting.png>] [18]
 Chapter 4.
 [19
 
 ] [20]
-Underfull \hbox (badness 10000) in paragraph at lines 1042--1043
+Underfull \hbox (badness 10000) in paragraph at lines 1047--1048
 []\T1/pcr/m/n/10 regression.increase_num_extra_steps_with_restart \T1/ptm/m/n/1
 0 - The amount to in-crease
  []
 
 
-Underfull \hbox (badness 10000) in paragraph at lines 1077--1078
+Underfull \hbox (badness 10000) in paragraph at lines 1082--1083
 []\T1/pcr/m/n/10 restarts.hard.increase_ndirs_initial_amt \T1/ptm/m/n/10 - Amou
 nt to in-crease \T1/pcr/m/n/10 growing.
  []
 
 [21]
-Underfull \hbox (badness 8000) in paragraph at lines 1112--1113
+Underfull \hbox (badness 8000) in paragraph at lines 1117--1118
 \T1/ptm/m/n/10 De-fault is \T1/pcr/m/n/10 False \T1/ptm/m/n/10 if $\OML/cmm/m/i
 t/10 m \OMS/cmsy/m/n/10 ^^U \OML/cmm/m/it/10 n$ \T1/ptm/m/n/10 and \T1/pcr/m/n/
 10 True \T1/ptm/m/n/10 oth-er-wise (op-po-site to \T1/pcr/m/n/10 growing.full_r
@@ -1234,14 +1234,14 @@ Chapter 7.
 ] [30
 
 ] (./DFOLS.ind)
-Package atveryend Info: Empty hook `BeforeClearDocument' on input line 1386.
+Package atveryend Info: Empty hook `BeforeClearDocument' on input line 1391.
  [31
 
 ]
-Package atveryend Info: Empty hook `AfterLastShipout' on input line 1386.
+Package atveryend Info: Empty hook `AfterLastShipout' on input line 1391.
  (./DFOLS.aux)
-Package atveryend Info: Executing hook `AtVeryEndDocument' on input line 1386.
-Package atveryend Info: Executing hook `AtEndAfterFileList' on input line 1386.
+Package atveryend Info: Executing hook `AtVeryEndDocument' on input line 1391.
+Package atveryend Info: Executing hook `AtEndAfterFileList' on input line 1391.
 
 Package rerunfilecheck Info: File `DFOLS.out' has not changed.
 (rerunfilecheck)             Checksum: 79AD965942E227C1E9BC996405ECE3B5;8394.
@@ -1273,10 +1273,10 @@ lvetic/uhvb8a.pfb></usr/share/texlive/texmf-dist/fonts/type1/urw/helvetic/uhvbo
 8a.pfb></usr/share/texlive/texmf-dist/fonts/type1/urw/times/utmb8a.pfb></usr/sh
 are/texlive/texmf-dist/fonts/type1/urw/times/utmr8a.pfb></usr/share/texlive/tex
 mf-dist/fonts/type1/urw/times/utmri8a.pfb>
-Output written on DFOLS.pdf (35 pages, 299620 bytes).
+Output written on DFOLS.pdf (35 pages, 299805 bytes).
 PDF statistics:
- 566 PDF objects out of 1000 (max. 8388607)
- 497 compressed objects within 5 object streams
+ 567 PDF objects out of 1000 (max. 8388607)
+ 498 compressed objects within 5 object streams
  92 named destinations out of 1000 (max. 500000)
  426 words of extra memory for PDF output out of 10000 (max. 10000000)
 
diff --git a/docs/build/latex/DFOLS.pdf b/docs/build/latex/DFOLS.pdf
diff --git a/docs/build/latex/DFOLS.tex b/docs/build/latex/DFOLS.tex
@@ -137,8 +137,13 @@ \section{Requirements}
 \item {} 
 Pandas 0.17 or higher (\sphinxurl{http://pandas.pydata.org/})
 
+\item {} 
+trustregion 1.1 or higher (\sphinxurl{https://github.com/lindonroberts/trust-region})
+
 \end{itemize}
 
+\sphinxstylestrong{Warning:} the trustregion package requires NumPy to already be installed. Please install NumPy before following the installation instructions below. This applies to DFO\sphinxhyphen{}LS versions 1.2 and higher.
+
 
 \section{Installation using pip}
 \label{\detokenize{install:installation-using-pip}}