Skip to content

Commit 867cfc0

Browse files
Updated README
1 parent 3494449 commit 867cfc0

File tree

1 file changed

+6
-16
lines changed

1 file changed

+6
-16
lines changed

README.rst

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
====================================================================================
2-
DFO-GN: Derivative-Free Nonlinear Least-Squares Solver |Build Status| |PyPI Version|
3-
====================================================================================
1+
=====================================================================
2+
DFO-GN: Derivative-Free Nonlinear Least-Squares Solver |PyPI Version|
3+
=====================================================================
44
DFO-GN is a package for solving nonlinear least-squares minimisation, without requiring derivatives of the objective.
55

66
This is an implementation of the algorithm from our paper:
77
A Derivative-Free Gauss-Newton Method, C. Cartis and L. Roberts, submitted (2017).
88

99
Documentation
1010
-------------
11-
Documentation for DFO-GN is available at [URL].
11+
See manual.pdf.
1212

1313
Requirements
1414
------------
@@ -55,14 +55,6 @@ The source code for DFO-GN is `available on Github <https://https://github.com/n
5555
$ git clone https://github.com/numericalalgorithmsgroup/dfogn
5656
$ cd dfogn
5757
58-
or through the `Python Package Index <https://pypi.python.org/pypi/dfogn>`_:
59-
60-
.. code-block:: bash
61-
62-
$ wget http://pypi.python.org/packages/source/d/dfogn/dfogn-X.X.tar.gz
63-
$ tar -xzvf dfogn-X.X.tar.gz
64-
$ cd dfogn-X.X
65-
6658
DFO-GN is written in pure Python and requires no compilation. It can be installed using:
6759

6860
.. code-block:: bash
@@ -85,9 +77,7 @@ If you installed DFO-GN manually, you can test your installation by running:
8577
8678
$ python setup.py test
8779
88-
Alternatively, the HTML documentation provides some simple examples of how to run DFO-GN.
80+
Alternatively, the documentation provides some simple examples of how to run DFO-GN, which are also available in the examples directory.
8981

90-
.. |Build Status| image:: https://travis-ci.org/numericalalgorithmsgroup/DFOGN.svg?branch=master
91-
:target: https://travis-ci.org/numericalalgorithmsgroup/DFOGN
9282
.. |PyPI Version| image:: https://img.shields.io/pypi/v/DFOGN.svg
93-
:target: https://pypi.python.org/pypi/DFOGN
83+
:target: https://pypi.python.org/pypi/DFOGN

0 commit comments

Comments
 (0)