Skip to content

Commit a2aec70

Browse files
committed
updates
updated license. added logo. updated readme.
1 parent 62662bb commit a2aec70

File tree

6 files changed

+204
-19
lines changed

6 files changed

+204
-19
lines changed

disclaimer.txt renamed to LICENSE.txt

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
1+
Modernized Minpack
2+
https://github.com/jacobwilliams/minpack
3+
Copyright (c) 2021, Jacob Williams
4+
All rights reserved.
5+
6+
Redistribution and use in source and binary forms, with or without modification,
7+
are permitted provided that the following conditions are met:
8+
9+
* Redistributions of source code must retain the above copyright notice, this
10+
list of conditions and the following disclaimer.
11+
12+
* Redistributions in binary form must reproduce the above copyright notice, this
13+
list of conditions and the following disclaimer in the documentation and/or
14+
other materials provided with the distribution.
15+
16+
* The names of its contributors may not be used to endorse or promote products
17+
derived from this software without specific prior written permission.
18+
19+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
23+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29+
30+
========================================================================================
31+
Original Minpack license
32+
========================================================================================
33+
134
Minpack Copyright Notice (1999) University of Chicago. All rights reserved
235

336
Redistribution and use in source and binary forms, with or

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
1-
# minpack
1+
![Minpack](media/logo.png)
2+
============
3+
24
Modernized Minpack
5+
6+
![Build Status](https://github.com/jacobwilliams/minpack/actions/workflows/CI.yml/badge.svg)
7+
8+
### Description
9+
10+
Minpack includes software for solving nonlinear equations and
11+
nonlinear least squares problems. Five algorithmic paths each include
12+
a core subroutine and an easy-to-use driver. The algorithms proceed
13+
either from an analytic specification of the Jacobian matrix or
14+
directly from the problem functions. The paths include facilities for
15+
systems of equations with a banded Jacobian matrix, for least squares
16+
problems with a large amount of data, and for checking the consistency
17+
of the Jacobian matrix with the functions.
18+
19+
This version is a modernization of the original Fortran 77 code. This is a work in progress. Modifications include:
20+
* Conversion from fixed (`.f`) to free-form (`.f90`) source.
21+
* Modified the tests so they can be automatically run in the [CI](https://github.com/jacobwilliams/minpack/actions)
22+
23+
Further updated are planned...
24+
25+
### Documentation
26+
27+
* The API documentation for the current ```master``` branch can be found [here](https://jacobwilliams.github.io/minpack/). This is generated by processing the source files with [FORD](https://github.com/Fortran-FOSS-Programmers/ford).
28+
29+
### License
30+
31+
The Minpack source code and related files and documentation are distributed under a permissive free software [license](https://github.com/jacobwilliams/minpack/blob/master/LICENSE.txt) (BSD-style).
32+
33+
### References
34+
* Original sourcecode from: [Netlib](https://www.netlib.org/minpack/)
35+
* J. J. Moré, B. S. Garbow, and K. E. Hillstrom, [User Guide for MINPACK-1](http://cds.cern.ch/record/126569/files/CM-P00068642.pdf), Argonne National Laboratory Report ANL-80-74, Argonne, Ill., 1980.
36+
* J. J. Moré, D. C. Sorensen, K. E. Hillstrom, and B. S. Garbow, The MINPACK Project, in Sources and Development of Mathematical Software, W. J. Cowell, ed., Prentice-Hall, pages 88-111, 1984.

media/logo.png

21.1 KB
Loading

media/logo.svg

Lines changed: 135 additions & 0 deletions
Loading

minpack.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
project: minpack
22
project_dir: ./src
33
output_dir: ./doc
4+
media_dir: ./media
45
project_github: https://github.com/jacobwilliams/minpack
56
summary: Modernized Minpack
67
author: Jacob Williams

readme.txt

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)