-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
236 lines (172 loc) · 9.27 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
Dear User,
You received a copy of OpenOCL in the form of ready to use code. OpenOCL
is a free and open-source software that itself relies on and uses other
open-source software. This software is not distributed with this package but
it will be downloaded through CasADi, given your consent, upon the first time
running OpenOCL.
We would like to give attribution to the used software as much as we can.
We would therefore like to ask you (as the user) to have a look at the
attributions below, and recognize the work of the used software by
OpenOCL, and cite the given papers in academic work.
For a documentation please go to https://openocl.org/ and have a look at the
examples in the folder Examples.
All the best
The OpenOCL developers
OpenOCL Release #dateversion#
Copyright 2019 Jonas Koenemann, Moritz Diehl, University of Freiburg
Redistribution is permitted under the 3-Clause BSD License terms. Please
ensure the above copyright notice is visible in any derived work.
The project is at the time of the release being developed at University of
Freiburg, Germany, under the supervision of Prof. Moritz Diehl.
Main developer:
Jonas Koenemann, https://github.com/jkoendev, [email protected]
Systems Control and Optimization Laboratory,
Department of Microsystems Engineering (IMTEK) and Department of Mathematics,
University of Freiburg, Georges-Koehler-Allee 102, 79110 Freiburg, Germany
This research was supported by the German Federal Ministry for Economic
Affairs and Energy (BMWi) via eco4wind (0324125B) and DyConPV (0324166B),
and by DFG via Research Unit FOR 2401.
The project has received funding from the European Union’s Horizon 2020
research and innovation programme under the Marie Sklodowska-Curie grant
agreement No 642682.
OpenOCL: Copyright 2019 Jonas Koenemann, Moritz Diehl, University of Freiburg
https://openocl.org
https://www.syscop.de/
https://github.com/jkoendev
https://github.com/OpenOCL/OpenOCL
## Attributions to the software used in OpenOCL
### CasADi
https://casadi.org
If you use CasADi in your academic work, please cite the following paper:
@Article{Andersson2018, Author = {Joel A E Andersson and Joris Gillis and
Greg Horn and James B Rawlings and Moritz Diehl},
Title = {{CasADi} -- {A} software framework for nonlinear optimization and
optimal control},
Journal = {Mathematical Programming Computation},
Year = {In Press, 2018}, }
CasADi comes with some external software. You can find the source code and
license information for the software used by casadi
in ThirdParty/casadi/external_packages
Software packages in CasADi:
- Sundials
- Blasfeo
- Csparse
- HPMPC
- TinyXML
- Lapack
- blockSQP
- Snopt interface
### Ipopt
https://github.com/coin-or/Ipopt
For licensing information for files in this directory, please see the
comments in the header of each file. For licensing of files in each of
the subdirectories, please see the LICENSE file in that subdirectory.
Since a lot of time and effort has gone into Ipopt's development, please cite
the following publication if you are using Ipopt for your own research:
A. Wächter and L. T. Biegler, On the Implementation of a Primal-Dual Interior
Point Filter Line Search Algorithm for Large-Scale Nonlinear Programming,
Mathematical Programming 106(1), pp. 25-57, 2006 (preprint)
### BLAS
http://www.netlib.org/blas/
The reference BLAS is a freely-available software package. It is available from
netlib via anonymous ftp and the World Wide Web. Thus, it can be included in
commercial software packages (and has been). We only ask that proper credit be
given to the authors.
Like all software, it is copyrighted. It is not trademarked, but we do ask the
following:
If you modify the source for these routines we ask that you change the name of
the routine and comment the changes made to the original.
We will gladly answer any questions regarding the software. If a modification
is done, however, it is the responsibility of the person who modified the
routine to provide support.
### Lapack
http://www.netlib.org/lapack/
LAPACK is a freely-available software package. It is available from netlib
via anonymous ftp and the World Wide Web at http://www.netlib.org/lapack.
Thus, it can be included in commercial software packages (and has been).
We only ask that proper credit be given to the authors.
The license used for the software is the modified BSD license
Like all software, it is copyrighted. It is not trademarked, but we do ask
the following:
If you modify the source for these routines we ask that you change the name
of the routine and comment the changes made to the original.
We will gladly answer any questions regarding the software. If a modification
is done, however, it is the responsibility of the person who modified the
routine to provide support.
### Metis
http://glaros.dtc.umn.edu/gkhome/metis/metis/overview
Copyright & License Notice
---------------------------
Copyright 1995-2013, Regents of the University of Minnesota
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied. See the License for the specific language governing
permissions and limitations under the License.
How to cite METIS?
“A Fast and Highly Quality Multilevel Scheme for Partitioning Irregular
Graphs”. George Karypis and Vipin Kumar. SIAM Journal on Scientific
Computing, Vol. 20, No. 1, pp. 359—392, 1999.
### Mumps
http://graal.ens-lyon.fr/MUMPS/
Copyright 1991-2019 CERFACS, CNRS, ENS Lyon, INP Toulouse, Inria,
Mumps Technologies, University of Bordeaux.
This version of MUMPS is provided to you free of charge. It is released
under the CeCILL-C license,
http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html, except for
the external and optional ordering PORD, in separate directory PORD,
which is public domain (see PORD/README).
You can acknowledge (using references [1] and [2]) the contribution of
this package in any scientific publication dependent upon the use of the
package. Please use reasonable endeavours to notify the authors of the
package of this publication.
[1] P. R. Amestoy, I. S. Duff, J. Koster and J.-Y. L'Excellent, A fully
asynchronous multifrontal solver using distributed dynamic scheduling,
SIAM Journal on Matrix Analysis and Applications, Vol 23, No 1, pp 15-41 (2001).
[2] P. R. Amestoy, A. Buttari, J.-Y. L'Excellent and T. Mary, Performance
and scalability of the block low-rank multifrontal factorization on multicore
architectures, ACM Transactions on Mathematical Software, Vol 45, Issue 1,
pp 2:1-2:26 (2019)
As a counterpart to the access to the source code and rights to copy, modify
and redistribute granted by the license, users are provided only with a
limited warranty and the software's author, the holder of the economic
rights, and the successive licensors have only limited liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also therefore
means that it is reserved for developers and experienced professionals
having in-depth computer knowledge. Users are therefore encouraged to load
and test the software's suitability as regards their requirements in
conditions enabling the security of their systems and/or data to be ensured
and, more generally, to use and operate it in the same conditions as regards
security.
The fact that you are presently reading this means that you have had knowledge
of the CeCILL-C license and that you accept its terms.
### SWIG (Matlab)
Swig is technically not distributed with OpenOCL but it is used to generate
the Matlab interface for CasADi.
You can find the source code at:
https://github.com/jkoendev/swig
SWIG is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version. See the LICENSE-GPL file for
the full terms of the GNU General Public license version 3.
Portions of SWIG are also licensed under the terms of the licenses
in the file LICENSE-UNIVERSITIES. You must observe the terms of
these licenses, as well as the terms of the GNU General Public License,
when you distribute SWIG.
The SWIG library and examples, under the Lib and Examples top level
directories, are distributed under the following terms:
You may copy, modify, distribute, and make derivative works based on
this software, in source code or object code form, without
restriction. If you distribute the software to others, you may do
so according to the terms of your choice. This software is offered as
is, without warranty of any kind.
See the COPYRIGHT file for a list of contributors to SWIG and their
copyright notices.