openstudio-analysis 0.4.3 → 0.4.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (101) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +19 -0
  3. data/.rubocop.yml +135 -0
  4. data/.travis.yml +6 -0
  5. data/CHANGELOG.md +5 -0
  6. data/Gemfile +11 -0
  7. data/LGPL-2.1.txt +502 -0
  8. data/LICENSE.txt +65 -0
  9. data/README.md +1 -1
  10. data/lib/openstudio/analysis/formulation.rb +15 -8
  11. data/lib/openstudio/analysis/server_api.rb +4 -6
  12. data/lib/openstudio/analysis/translator/excel.rb +1 -1
  13. data/lib/openstudio/analysis/version.rb +1 -1
  14. data/openstudio-analysis.gemspec +33 -0
  15. data/rubocop-todo.yml +246 -0
  16. data/spec/files/measures/NoMeasureRbFile/.gitkeep +0 -0
  17. data/spec/openstudio/formulation_spec.rb +36 -0
  18. data/spec/openstudio/hash_spec.rb +21 -0
  19. data/spec/spec_helper.rb +3 -0
  20. metadata +53 -169
  21. data/lib/openstudio/templates/analysis.json.erb +0 -20
  22. data/lib/openstudio/templates/argument.json.erb +0 -7
  23. data/lib/openstudio/templates/discrete_uncertain_variable.json.erb +0 -41
  24. data/lib/openstudio/templates/pivot_variable.json.erb +0 -32
  25. data/lib/openstudio/templates/uncertain_variable.json.erb +0 -45
  26. data/lib/openstudio/templates/workflow_item.json.erb +0 -16
  27. data/spec/files/analysis/example_analysis_api.json +0 -656
  28. data/spec/files/analysis/lhs_discrete_and_continuous_variables_api.json +0 -1230
  29. data/spec/files/analysis/medium_office.json +0 -1736
  30. data/spec/files/analysis/medium_office.zip +0 -0
  31. data/spec/files/analysis/name_goes_here.json +0 -1752
  32. data/spec/files/analysis/name_goes_here.zip +0 -0
  33. data/spec/files/analysis/name_goes_here_api.json +0 -1681
  34. data/spec/files/analysis/output_vars_api.json +0 -632
  35. data/spec/files/analysis/preflight_api.json +0 -1518
  36. data/spec/files/analysis/simple_test_api.json +0 -519
  37. data/spec/files/analysis/test_model_api.json +0 -493
  38. data/spec/files/export/analysis/0_1_09_outputvars.json +0 -678
  39. data/spec/files/export/analysis/0_1_09_outputvars.zip +0 -0
  40. data/spec/files/export/analysis/0_3_0_dynamic_uuids.json +0 -1490
  41. data/spec/files/export/analysis/0_3_0_dynamic_uuids.zip +0 -0
  42. data/spec/files/export/analysis/0_3_0_outputs.json +0 -1490
  43. data/spec/files/export/analysis/0_3_0_outputs.zip +0 -0
  44. data/spec/files/export/analysis/0_3_3_short_names.json +0 -1517
  45. data/spec/files/export/analysis/0_3_3_short_names.zip +0 -0
  46. data/spec/files/export/analysis/0_3_5_multiple_measure_paths.json +0 -1537
  47. data/spec/files/export/analysis/0_3_5_multiple_measure_paths.zip +0 -0
  48. data/spec/files/export/analysis/0_3_7_worker_init_final.json +0 -1537
  49. data/spec/files/export/analysis/0_3_7_worker_init_final.zip +0 -0
  50. data/spec/files/export/analysis/example_analysis.json +0 -727
  51. data/spec/files/export/analysis/example_analysis.zip +0 -0
  52. data/spec/files/export/analysis/lhs_discrete_and_continuous_variables.json +0 -1298
  53. data/spec/files/export/analysis/lhs_discrete_and_continuous_variables.zip +0 -0
  54. data/spec/files/export/analysis/lhs_discrete_and_continuous_variables_f4a73fc4-0514-4033-b54d-d1c58c77c724.json +0 -1298
  55. data/spec/files/export/analysis/lhs_discrete_and_continuous_variables_f4a73fc4-0514-4033-b54d-d1c58c77c724.zip +0 -0
  56. data/spec/files/export/analysis/lhs_discrete_and_continuous_variables_model_-_1.json +0 -1298
  57. data/spec/files/export/analysis/lhs_discrete_and_continuous_variables_model_-_1.zip +0 -0
  58. data/spec/files/export/analysis/lhs_discrete_and_continuous_variables_something_else.json +0 -1298
  59. data/spec/files/export/analysis/lhs_discrete_and_continuous_variables_something_else.zip +0 -0
  60. data/spec/files/export/analysis/pivot_test.json +0 -1323
  61. data/spec/files/export/analysis/pivot_test.zip +0 -0
  62. data/spec/files/export/analysis/simple_test.json +0 -551
  63. data/spec/files/export/analysis/simple_test.zip +0 -0
  64. data/spec/files/export/analysis/test_model.json +0 -524
  65. data/spec/files/export/analysis/test_model.zip +0 -0
  66. data/spec/files/export/weather/weather_out.epw +0 -32
  67. data/spec/files/export/weather/weather_out_appended.epw +0 -56
  68. data/spec/files/export/workflow/analysis.json +0 -22
  69. data/spec/files/measures/ActualMeasureNoJson/measure.json +0 -25
  70. data/spec/reports/SPEC-OpenStudio-Analysis-Formulation.xml +0 -77
  71. data/spec/reports/SPEC-OpenStudio-Analysis-ServerApi-create-a-new-object-instance.xml +0 -5
  72. data/spec/reports/SPEC-OpenStudio-Analysis-ServerApi-test-not-localhost.xml +0 -5
  73. data/spec/reports/SPEC-OpenStudio-Analysis-ServerApi.xml +0 -3
  74. data/spec/reports/SPEC-OpenStudio-Analysis-SupportFiles.xml +0 -15
  75. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-discrete-variables.xml +0 -31
  76. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-discrete-with-dynamic-columns.xml +0 -24
  77. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-no-variables-defined.xml +0 -11
  78. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-proxy-setup-with-user.xml +0 -5
  79. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-proxy-setup.xml +0 -5
  80. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-setup-output-variables.xml +0 -40
  81. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-setup-version-0-1-9.xml +0 -11
  82. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-small-list-of-incomplete-variables.xml +0 -5
  83. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-small-list-of-variables-should-not-validate.xml +0 -5
  84. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-small-list-of-variables.xml +0 -34
  85. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-small-list-with-with-repeated-variable-names.xml +0 -5
  86. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-version-0-1-10.xml +0 -7
  87. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-version-0-2-0-simple.xml +0 -28
  88. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-version-0-2-0.xml +0 -43
  89. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-version-0-3-0-dynamic-uuid-assignments.xml +0 -53
  90. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-version-0-3-0-measure-existence-checks.xml +0 -7
  91. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-version-0-3-0-objective-functions.xml +0 -55
  92. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-version-0-3-3-and-short-display-names.xml +0 -54
  93. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-version-0-3-5-and-measure-paths.xml +0 -53
  94. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-version-0-3-7-and-worker-init-final-scripts.0.xml +0 -60
  95. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-version-0-3-7-and-worker-init-final-scripts.xml +0 -56
  96. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-version-0-4-0-multiple-seed-models.xml +0 -165
  97. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel-version-0-4-0-pivot-test.xml +0 -60
  98. data/spec/reports/SPEC-OpenStudio-Analysis-Translator-Excel.xml +0 -3
  99. data/spec/reports/SPEC-OpenStudio-Analysis-Workflow.xml +0 -31
  100. data/spec/reports/SPEC-OpenStudio-Analysis-WorkflowStep.xml +0 -23
  101. data/spec/reports/SPEC-OpenStudio-Weather-Epw.xml +0 -9
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 0e2234bf02d68d5c389ae087659a5ccf9a3151f6
4
- data.tar.gz: c2a06a1e663d5875bc4bd0cf47c9b3f440b1e41d
3
+ metadata.gz: e28750e00afea6e55e5852a8629ddf0e7cec2760
4
+ data.tar.gz: 8fdc2d023f6c151220fda7b06e5f01930cb4b379
5
5
  SHA512:
6
- metadata.gz: 00fcc700426dec77ff30ba768b5dff7adf1037a8aab9ec2e079c80b47a7dd86c7532dfe45d0c3736a5a4adafa0208b69a7ae43b52021a5ce03f4e9da9a4dce93
7
- data.tar.gz: 12cd3030a23bd2fdc2ac0970bf6b253729b925538f5d99a427cb890823bc08f5110b135971c25a11bf3bca6dd7d26a55a51e2ecf40480c2761124f0a2fecffbc
6
+ metadata.gz: 00526e6a206c1721906344469701b526dd1cfa0d0693c3be8f79a5240239321f6339a010a149de13bf3edb673a07e4188afdff31e3dbbc3b27a0c35b8e63e624
7
+ data.tar.gz: 834f5922be6edb2f5cbf550c1e0d0bb6daa0ed3109538d440ebec09195efc753892238ba80cd9707d7790330760da42385516d0836c385eba0059cc6259087da
data/.gitignore ADDED
@@ -0,0 +1,19 @@
1
+ .DS_Store
2
+ .bundle
3
+ .idea
4
+ .ruby-version
5
+ *.swp
6
+ *.gem
7
+ ~$*
8
+ tmp/*
9
+ .yardoc
10
+ doc/
11
+ Gemfile.lock
12
+ /spec/files/analysis/*.zip
13
+ /spec/files/export
14
+ /spec/reports
15
+ /spec/files/analysis/*.json
16
+ /*.log
17
+ spec/files/measures/ActualMeasureNoJson/measure.json
18
+ rubocop-results.xml
19
+ coverage
data/.rubocop.yml ADDED
@@ -0,0 +1,135 @@
1
+ AllCops:
2
+ Exclude:
3
+ - 'spec/files/measures/**/*'
4
+ - 'spec/files/measures_second_path/**/*'
5
+ - 'spec/files/worker_init/*'
6
+
7
+ # ==================== Linters ====================
8
+ Lint/AmbiguousOperator:
9
+ Enabled: true
10
+
11
+ Lint/BlockAlignment:
12
+ Enabled: true
13
+
14
+ Lint/ParenthesesAsGroupedExpression:
15
+ Enabled: true
16
+
17
+ Lint/RequireParentheses:
18
+ Enabled: true
19
+
20
+ # Offense count: 1
21
+ Lint/UnreachableCode:
22
+ Enabled: false
23
+
24
+ # Offense count: 51
25
+ Lint/UselessAssignment:
26
+ Enabled: true
27
+
28
+ # ==================== Styles / Metrics====================
29
+ # Offense count: 4
30
+ Metrics/BlockNesting:
31
+ Max: 4
32
+
33
+ # Offense count: 18
34
+ # Configuration parameters: CountComments.
35
+ Metrics/ClassLength:
36
+ Max: 500
37
+
38
+ # Offense count: 27
39
+ Metrics/CyclomaticComplexity:
40
+ Max: 48
41
+
42
+ # Offense count: 974
43
+ Metrics/LineLength:
44
+ Max: 1200
45
+
46
+ # Offense count: 87
47
+ # Configuration parameters: CountComments.
48
+ Metrics/MethodLength:
49
+ Max: 350
50
+
51
+ # Offense count: 1
52
+ # Configuration parameters: CountKeywordArgs.
53
+ Metrics/ParameterLists:
54
+ Max: 8
55
+
56
+ # ==================== Disabled on Purpose ====================
57
+ # Offense count: 3
58
+ Style/AccessorMethodName:
59
+ Enabled: true
60
+
61
+ # Need to allow indented case statements
62
+ # Offense count: 9
63
+ # Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
64
+ Style/CaseIndentation:
65
+ Enabled: false
66
+
67
+ # Offense count: 18
68
+ # Configuration parameters: EnforcedStyle, SupportedStyles.
69
+ Style/ClassAndModuleChildren:
70
+ Enabled: false
71
+
72
+ # Offense count: 2
73
+ Style/ClassVars:
74
+ Enabled: false
75
+
76
+ # Offense count: 42
77
+ Style/Documentation:
78
+ Enabled: false
79
+
80
+ # Offense count: 1
81
+ Style/EachWithObject:
82
+ Enabled: false
83
+
84
+ # Offense count: 2
85
+ # Configuration parameters: AllowedVariables.
86
+ Style/GlobalVars:
87
+ Enabled: false
88
+
89
+ # Offense count: 7
90
+ # Configuration parameters: MinBodyLength.
91
+ Style/GuardClause:
92
+ Enabled: true
93
+
94
+ # Offense count: 17
95
+ # Configuration parameters: MaxLineLength.
96
+ Style/IfUnlessModifier:
97
+ Enabled: false
98
+
99
+ # Do NOT enable. For some reason this is catchy any next which I feel are okay.
100
+ # Offense count: 18
101
+ # Configuration parameters: EnforcedStyle, SupportedStyles.
102
+ Style/Next:
103
+ Enabled: false
104
+
105
+ # Do NOT enable this because it appears $? is different than $CHILD_STATUS.
106
+ # Offense count: 7
107
+ # Cop supports --auto-correct.
108
+ Style/SpecialGlobalVars:
109
+ Enabled: false
110
+
111
+ # More Changes per DLM -- pulled from https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
112
+ Style/RedundantReturn:
113
+ Description: 'Do not use return where it is not required.'
114
+ StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-explicit-return'
115
+ Enabled: false
116
+
117
+ Style/NumericLiterals:
118
+ Description: 'Add underscores to large numeric literals to improve readability.'
119
+ StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscores-in-numerics'
120
+ Enabled: false
121
+
122
+ Lint/UnusedBlockArgument:
123
+ Description: 'Checks for unused block arguments.'
124
+ StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
125
+ Enabled: false
126
+
127
+ Lint/UnusedMethodArgument:
128
+ Description: 'Checks for unused method arguments.'
129
+ StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
130
+ Enabled: false
131
+
132
+ Lint/UselessAssignment:
133
+ Description: 'Checks for useless assignment to a local variable.'
134
+ StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
135
+ Enabled: false
data/.travis.yml ADDED
@@ -0,0 +1,6 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.0.0
4
+ - 1.9.3
5
+ - jruby-19mode
6
+
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  OpenStudio Analysis Gem Change Log
2
2
  ==================================
3
3
 
4
+ Version 0.4.4
5
+ ------------------
6
+ * Increment objective function count only if they are true
7
+ * Do not add an output if the variable name has already been added
8
+
4
9
  Version 0.4.3
5
10
  ------------------
6
11
  * Add defaults to the OpenStudio::Analysis::ServerApi .run method.
data/Gemfile ADDED
@@ -0,0 +1,11 @@
1
+ source 'http://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :test do
6
+ gem 'coveralls', require: false
7
+ gem 'rspec', '~> 3.3.0'
8
+ gem 'ci_reporter_rspec'
9
+ gem 'rubocop', '~> 0.31'
10
+ gem 'rubocop-checkstyle_formatter', '~> 0.2'
11
+ end
data/LGPL-2.1.txt ADDED
@@ -0,0 +1,502 @@
1
+ GNU LESSER GENERAL PUBLIC LICENSE
2
+ Version 2.1, February 1999
3
+
4
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ [This is the first released version of the Lesser GPL. It also counts
10
+ as the successor of the GNU Library Public License, version 2, hence
11
+ the version number 2.1.]
12
+
13
+ Preamble
14
+
15
+ The licenses for most software are designed to take away your
16
+ freedom to share and change it. By contrast, the GNU General Public
17
+ Licenses are intended to guarantee your freedom to share and change
18
+ free software--to make sure the software is free for all its users.
19
+
20
+ This license, the Lesser General Public License, applies to some
21
+ specially designated software packages--typically libraries--of the
22
+ Free Software Foundation and other authors who decide to use it. You
23
+ can use it too, but we suggest you first think carefully about whether
24
+ this license or the ordinary General Public License is the better
25
+ strategy to use in any particular case, based on the explanations below.
26
+
27
+ When we speak of free software, we are referring to freedom of use,
28
+ not price. Our General Public Licenses are designed to make sure that
29
+ you have the freedom to distribute copies of free software (and charge
30
+ for this service if you wish); that you receive source code or can get
31
+ it if you want it; that you can change the software and use pieces of
32
+ it in new free programs; and that you are informed that you can do
33
+ these things.
34
+
35
+ To protect your rights, we need to make restrictions that forbid
36
+ distributors to deny you these rights or to ask you to surrender these
37
+ rights. These restrictions translate to certain responsibilities for
38
+ you if you distribute copies of the library or if you modify it.
39
+
40
+ For example, if you distribute copies of the library, whether gratis
41
+ or for a fee, you must give the recipients all the rights that we gave
42
+ you. You must make sure that they, too, receive or can get the source
43
+ code. If you link other code with the library, you must provide
44
+ complete object files to the recipients, so that they can relink them
45
+ with the library after making changes to the library and recompiling
46
+ it. And you must show them these terms so they know their rights.
47
+
48
+ We protect your rights with a two-step method: (1) we copyright the
49
+ library, and (2) we offer you this license, which gives you legal
50
+ permission to copy, distribute and/or modify the library.
51
+
52
+ To protect each distributor, we want to make it very clear that
53
+ there is no warranty for the free library. Also, if the library is
54
+ modified by someone else and passed on, the recipients should know
55
+ that what they have is not the original version, so that the original
56
+ author's reputation will not be affected by problems that might be
57
+ introduced by others.
58
+
59
+ Finally, software patents pose a constant threat to the existence of
60
+ any free program. We wish to make sure that a company cannot
61
+ effectively restrict the users of a free program by obtaining a
62
+ restrictive license from a patent holder. Therefore, we insist that
63
+ any patent license obtained for a version of the library must be
64
+ consistent with the full freedom of use specified in this license.
65
+
66
+ Most GNU software, including some libraries, is covered by the
67
+ ordinary GNU General Public License. This license, the GNU Lesser
68
+ General Public License, applies to certain designated libraries, and
69
+ is quite different from the ordinary General Public License. We use
70
+ this license for certain libraries in order to permit linking those
71
+ libraries into non-free programs.
72
+
73
+ When a program is linked with a library, whether statically or using
74
+ a shared library, the combination of the two is legally speaking a
75
+ combined work, a derivative of the original library. The ordinary
76
+ General Public License therefore permits such linking only if the
77
+ entire combination fits its criteria of freedom. The Lesser General
78
+ Public License permits more lax criteria for linking other code with
79
+ the library.
80
+
81
+ We call this license the "Lesser" General Public License because it
82
+ does Less to protect the user's freedom than the ordinary General
83
+ Public License. It also provides other free software developers Less
84
+ of an advantage over competing non-free programs. These disadvantages
85
+ are the reason we use the ordinary General Public License for many
86
+ libraries. However, the Lesser license provides advantages in certain
87
+ special circumstances.
88
+
89
+ For example, on rare occasions, there may be a special need to
90
+ encourage the widest possible use of a certain library, so that it becomes
91
+ a de-facto standard. To achieve this, non-free programs must be
92
+ allowed to use the library. A more frequent case is that a free
93
+ library does the same job as widely used non-free libraries. In this
94
+ case, there is little to gain by limiting the free library to free
95
+ software only, so we use the Lesser General Public License.
96
+
97
+ In other cases, permission to use a particular library in non-free
98
+ programs enables a greater number of people to use a large body of
99
+ free software. For example, permission to use the GNU C Library in
100
+ non-free programs enables many more people to use the whole GNU
101
+ operating system, as well as its variant, the GNU/Linux operating
102
+ system.
103
+
104
+ Although the Lesser General Public License is Less protective of the
105
+ users' freedom, it does ensure that the user of a program that is
106
+ linked with the Library has the freedom and the wherewithal to run
107
+ that program using a modified version of the Library.
108
+
109
+ The precise terms and conditions for copying, distribution and
110
+ modification follow. Pay close attention to the difference between a
111
+ "work based on the library" and a "work that uses the library". The
112
+ former contains code derived from the library, whereas the latter must
113
+ be combined with the library in order to run.
114
+
115
+ GNU LESSER GENERAL PUBLIC LICENSE
116
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
117
+
118
+ 0. This License Agreement applies to any software library or other
119
+ program which contains a notice placed by the copyright holder or
120
+ other authorized party saying it may be distributed under the terms of
121
+ this Lesser General Public License (also called "this License").
122
+ Each licensee is addressed as "you".
123
+
124
+ A "library" means a collection of software functions and/or data
125
+ prepared so as to be conveniently linked with application programs
126
+ (which use some of those functions and data) to form executables.
127
+
128
+ The "Library", below, refers to any such software library or work
129
+ which has been distributed under these terms. A "work based on the
130
+ Library" means either the Library or any derivative work under
131
+ copyright law: that is to say, a work containing the Library or a
132
+ portion of it, either verbatim or with modifications and/or translated
133
+ straightforwardly into another language. (Hereinafter, translation is
134
+ included without limitation in the term "modification".)
135
+
136
+ "Source code" for a work means the preferred form of the work for
137
+ making modifications to it. For a library, complete source code means
138
+ all the source code for all modules it contains, plus any associated
139
+ interface definition files, plus the scripts used to control compilation
140
+ and installation of the library.
141
+
142
+ Activities other than copying, distribution and modification are not
143
+ covered by this License; they are outside its scope. The act of
144
+ running a program using the Library is not restricted, and output from
145
+ such a program is covered only if its contents constitute a work based
146
+ on the Library (independent of the use of the Library in a tool for
147
+ writing it). Whether that is true depends on what the Library does
148
+ and what the program that uses the Library does.
149
+
150
+ 1. You may copy and distribute verbatim copies of the Library's
151
+ complete source code as you receive it, in any medium, provided that
152
+ you conspicuously and appropriately publish on each copy an
153
+ appropriate copyright notice and disclaimer of warranty; keep intact
154
+ all the notices that refer to this License and to the absence of any
155
+ warranty; and distribute a copy of this License along with the
156
+ Library.
157
+
158
+ You may charge a fee for the physical act of transferring a copy,
159
+ and you may at your option offer warranty protection in exchange for a
160
+ fee.
161
+
162
+ 2. You may modify your copy or copies of the Library or any portion
163
+ of it, thus forming a work based on the Library, and copy and
164
+ distribute such modifications or work under the terms of Section 1
165
+ above, provided that you also meet all of these conditions:
166
+
167
+ a) The modified work must itself be a software library.
168
+
169
+ b) You must cause the files modified to carry prominent notices
170
+ stating that you changed the files and the date of any change.
171
+
172
+ c) You must cause the whole of the work to be licensed at no
173
+ charge to all third parties under the terms of this License.
174
+
175
+ d) If a facility in the modified Library refers to a function or a
176
+ table of data to be supplied by an application program that uses
177
+ the facility, other than as an argument passed when the facility
178
+ is invoked, then you must make a good faith effort to ensure that,
179
+ in the event an application does not supply such function or
180
+ table, the facility still operates, and performs whatever part of
181
+ its purpose remains meaningful.
182
+
183
+ (For example, a function in a library to compute square roots has
184
+ a purpose that is entirely well-defined independent of the
185
+ application. Therefore, Subsection 2d requires that any
186
+ application-supplied function or table used by this function must
187
+ be optional: if the application does not supply it, the square
188
+ root function must still compute square roots.)
189
+
190
+ These requirements apply to the modified work as a whole. If
191
+ identifiable sections of that work are not derived from the Library,
192
+ and can be reasonably considered independent and separate works in
193
+ themselves, then this License, and its terms, do not apply to those
194
+ sections when you distribute them as separate works. But when you
195
+ distribute the same sections as part of a whole which is a work based
196
+ on the Library, the distribution of the whole must be on the terms of
197
+ this License, whose permissions for other licensees extend to the
198
+ entire whole, and thus to each and every part regardless of who wrote
199
+ it.
200
+
201
+ Thus, it is not the intent of this section to claim rights or contest
202
+ your rights to work written entirely by you; rather, the intent is to
203
+ exercise the right to control the distribution of derivative or
204
+ collective works based on the Library.
205
+
206
+ In addition, mere aggregation of another work not based on the Library
207
+ with the Library (or with a work based on the Library) on a volume of
208
+ a storage or distribution medium does not bring the other work under
209
+ the scope of this License.
210
+
211
+ 3. You may opt to apply the terms of the ordinary GNU General Public
212
+ License instead of this License to a given copy of the Library. To do
213
+ this, you must alter all the notices that refer to this License, so
214
+ that they refer to the ordinary GNU General Public License, version 2,
215
+ instead of to this License. (If a newer version than version 2 of the
216
+ ordinary GNU General Public License has appeared, then you can specify
217
+ that version instead if you wish.) Do not make any other change in
218
+ these notices.
219
+
220
+ Once this change is made in a given copy, it is irreversible for
221
+ that copy, so the ordinary GNU General Public License applies to all
222
+ subsequent copies and derivative works made from that copy.
223
+
224
+ This option is useful when you wish to copy part of the code of
225
+ the Library into a program that is not a library.
226
+
227
+ 4. You may copy and distribute the Library (or a portion or
228
+ derivative of it, under Section 2) in object code or executable form
229
+ under the terms of Sections 1 and 2 above provided that you accompany
230
+ it with the complete corresponding machine-readable source code, which
231
+ must be distributed under the terms of Sections 1 and 2 above on a
232
+ medium customarily used for software interchange.
233
+
234
+ If distribution of object code is made by offering access to copy
235
+ from a designated place, then offering equivalent access to copy the
236
+ source code from the same place satisfies the requirement to
237
+ distribute the source code, even though third parties are not
238
+ compelled to copy the source along with the object code.
239
+
240
+ 5. A program that contains no derivative of any portion of the
241
+ Library, but is designed to work with the Library by being compiled or
242
+ linked with it, is called a "work that uses the Library". Such a
243
+ work, in isolation, is not a derivative work of the Library, and
244
+ therefore falls outside the scope of this License.
245
+
246
+ However, linking a "work that uses the Library" with the Library
247
+ creates an executable that is a derivative of the Library (because it
248
+ contains portions of the Library), rather than a "work that uses the
249
+ library". The executable is therefore covered by this License.
250
+ Section 6 states terms for distribution of such executables.
251
+
252
+ When a "work that uses the Library" uses material from a header file
253
+ that is part of the Library, the object code for the work may be a
254
+ derivative work of the Library even though the source code is not.
255
+ Whether this is true is especially significant if the work can be
256
+ linked without the Library, or if the work is itself a library. The
257
+ threshold for this to be true is not precisely defined by law.
258
+
259
+ If such an object file uses only numerical parameters, data
260
+ structure layouts and accessors, and small macros and small inline
261
+ functions (ten lines or less in length), then the use of the object
262
+ file is unrestricted, regardless of whether it is legally a derivative
263
+ work. (Executables containing this object code plus portions of the
264
+ Library will still fall under Section 6.)
265
+
266
+ Otherwise, if the work is a derivative of the Library, you may
267
+ distribute the object code for the work under the terms of Section 6.
268
+ Any executables containing that work also fall under Section 6,
269
+ whether or not they are linked directly with the Library itself.
270
+
271
+ 6. As an exception to the Sections above, you may also combine or
272
+ link a "work that uses the Library" with the Library to produce a
273
+ work containing portions of the Library, and distribute that work
274
+ under terms of your choice, provided that the terms permit
275
+ modification of the work for the customer's own use and reverse
276
+ engineering for debugging such modifications.
277
+
278
+ You must give prominent notice with each copy of the work that the
279
+ Library is used in it and that the Library and its use are covered by
280
+ this License. You must supply a copy of this License. If the work
281
+ during execution displays copyright notices, you must include the
282
+ copyright notice for the Library among them, as well as a reference
283
+ directing the user to the copy of this License. Also, you must do one
284
+ of these things:
285
+
286
+ a) Accompany the work with the complete corresponding
287
+ machine-readable source code for the Library including whatever
288
+ changes were used in the work (which must be distributed under
289
+ Sections 1 and 2 above); and, if the work is an executable linked
290
+ with the Library, with the complete machine-readable "work that
291
+ uses the Library", as object code and/or source code, so that the
292
+ user can modify the Library and then relink to produce a modified
293
+ executable containing the modified Library. (It is understood
294
+ that the user who changes the contents of definitions files in the
295
+ Library will not necessarily be able to recompile the application
296
+ to use the modified definitions.)
297
+
298
+ b) Use a suitable shared library mechanism for linking with the
299
+ Library. A suitable mechanism is one that (1) uses at run time a
300
+ copy of the library already present on the user's computer system,
301
+ rather than copying library functions into the executable, and (2)
302
+ will operate properly with a modified version of the library, if
303
+ the user installs one, as long as the modified version is
304
+ interface-compatible with the version that the work was made with.
305
+
306
+ c) Accompany the work with a written offer, valid for at
307
+ least three years, to give the same user the materials
308
+ specified in Subsection 6a, above, for a charge no more
309
+ than the cost of performing this distribution.
310
+
311
+ d) If distribution of the work is made by offering access to copy
312
+ from a designated place, offer equivalent access to copy the above
313
+ specified materials from the same place.
314
+
315
+ e) Verify that the user has already received a copy of these
316
+ materials or that you have already sent this user a copy.
317
+
318
+ For an executable, the required form of the "work that uses the
319
+ Library" must include any data and utility programs needed for
320
+ reproducing the executable from it. However, as a special exception,
321
+ the materials to be distributed need not include anything that is
322
+ normally distributed (in either source or binary form) with the major
323
+ components (compiler, kernel, and so on) of the operating system on
324
+ which the executable runs, unless that component itself accompanies
325
+ the executable.
326
+
327
+ It may happen that this requirement contradicts the license
328
+ restrictions of other proprietary libraries that do not normally
329
+ accompany the operating system. Such a contradiction means you cannot
330
+ use both them and the Library together in an executable that you
331
+ distribute.
332
+
333
+ 7. You may place library facilities that are a work based on the
334
+ Library side-by-side in a single library together with other library
335
+ facilities not covered by this License, and distribute such a combined
336
+ library, provided that the separate distribution of the work based on
337
+ the Library and of the other library facilities is otherwise
338
+ permitted, and provided that you do these two things:
339
+
340
+ a) Accompany the combined library with a copy of the same work
341
+ based on the Library, uncombined with any other library
342
+ facilities. This must be distributed under the terms of the
343
+ Sections above.
344
+
345
+ b) Give prominent notice with the combined library of the fact
346
+ that part of it is a work based on the Library, and explaining
347
+ where to find the accompanying uncombined form of the same work.
348
+
349
+ 8. You may not copy, modify, sublicense, link with, or distribute
350
+ the Library except as expressly provided under this License. Any
351
+ attempt otherwise to copy, modify, sublicense, link with, or
352
+ distribute the Library is void, and will automatically terminate your
353
+ rights under this License. However, parties who have received copies,
354
+ or rights, from you under this License will not have their licenses
355
+ terminated so long as such parties remain in full compliance.
356
+
357
+ 9. You are not required to accept this License, since you have not
358
+ signed it. However, nothing else grants you permission to modify or
359
+ distribute the Library or its derivative works. These actions are
360
+ prohibited by law if you do not accept this License. Therefore, by
361
+ modifying or distributing the Library (or any work based on the
362
+ Library), you indicate your acceptance of this License to do so, and
363
+ all its terms and conditions for copying, distributing or modifying
364
+ the Library or works based on it.
365
+
366
+ 10. Each time you redistribute the Library (or any work based on the
367
+ Library), the recipient automatically receives a license from the
368
+ original licensor to copy, distribute, link with or modify the Library
369
+ subject to these terms and conditions. You may not impose any further
370
+ restrictions on the recipients' exercise of the rights granted herein.
371
+ You are not responsible for enforcing compliance by third parties with
372
+ this License.
373
+
374
+ 11. If, as a consequence of a court judgment or allegation of patent
375
+ infringement or for any other reason (not limited to patent issues),
376
+ conditions are imposed on you (whether by court order, agreement or
377
+ otherwise) that contradict the conditions of this License, they do not
378
+ excuse you from the conditions of this License. If you cannot
379
+ distribute so as to satisfy simultaneously your obligations under this
380
+ License and any other pertinent obligations, then as a consequence you
381
+ may not distribute the Library at all. For example, if a patent
382
+ license would not permit royalty-free redistribution of the Library by
383
+ all those who receive copies directly or indirectly through you, then
384
+ the only way you could satisfy both it and this License would be to
385
+ refrain entirely from distribution of the Library.
386
+
387
+ If any portion of this section is held invalid or unenforceable under any
388
+ particular circumstance, the balance of the section is intended to apply,
389
+ and the section as a whole is intended to apply in other circumstances.
390
+
391
+ It is not the purpose of this section to induce you to infringe any
392
+ patents or other property right claims or to contest validity of any
393
+ such claims; this section has the sole purpose of protecting the
394
+ integrity of the free software distribution system which is
395
+ implemented by public license practices. Many people have made
396
+ generous contributions to the wide range of software distributed
397
+ through that system in reliance on consistent application of that
398
+ system; it is up to the author/donor to decide if he or she is willing
399
+ to distribute software through any other system and a licensee cannot
400
+ impose that choice.
401
+
402
+ This section is intended to make thoroughly clear what is believed to
403
+ be a consequence of the rest of this License.
404
+
405
+ 12. If the distribution and/or use of the Library is restricted in
406
+ certain countries either by patents or by copyrighted interfaces, the
407
+ original copyright holder who places the Library under this License may add
408
+ an explicit geographical distribution limitation excluding those countries,
409
+ so that distribution is permitted only in or among countries not thus
410
+ excluded. In such case, this License incorporates the limitation as if
411
+ written in the body of this License.
412
+
413
+ 13. The Free Software Foundation may publish revised and/or new
414
+ versions of the Lesser General Public License from time to time.
415
+ Such new versions will be similar in spirit to the present version,
416
+ but may differ in detail to address new problems or concerns.
417
+
418
+ Each version is given a distinguishing version number. If the Library
419
+ specifies a version number of this License which applies to it and
420
+ "any later version", you have the option of following the terms and
421
+ conditions either of that version or of any later version published by
422
+ the Free Software Foundation. If the Library does not specify a
423
+ license version number, you may choose any version ever published by
424
+ the Free Software Foundation.
425
+
426
+ 14. If you wish to incorporate parts of the Library into other free
427
+ programs whose distribution conditions are incompatible with these,
428
+ write to the author to ask for permission. For software which is
429
+ copyrighted by the Free Software Foundation, write to the Free
430
+ Software Foundation; we sometimes make exceptions for this. Our
431
+ decision will be guided by the two goals of preserving the free status
432
+ of all derivatives of our free software and of promoting the sharing
433
+ and reuse of software generally.
434
+
435
+ NO WARRANTY
436
+
437
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
438
+ WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
439
+ EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
440
+ OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
441
+ KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
442
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
443
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
444
+ LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
445
+ THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
446
+
447
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
448
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
449
+ AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
450
+ FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
451
+ CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
452
+ LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
453
+ RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
454
+ FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
455
+ SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
456
+ DAMAGES.
457
+
458
+ END OF TERMS AND CONDITIONS
459
+
460
+ How to Apply These Terms to Your New Libraries
461
+
462
+ If you develop a new library, and you want it to be of the greatest
463
+ possible use to the public, we recommend making it free software that
464
+ everyone can redistribute and change. You can do so by permitting
465
+ redistribution under these terms (or, alternatively, under the terms of the
466
+ ordinary General Public License).
467
+
468
+ To apply these terms, attach the following notices to the library. It is
469
+ safest to attach them to the start of each source file to most effectively
470
+ convey the exclusion of warranty; and each file should have at least the
471
+ "copyright" line and a pointer to where the full notice is found.
472
+
473
+ <one line to give the library's name and a brief idea of what it does.>
474
+ Copyright (C) <year> <name of author>
475
+
476
+ This library is free software; you can redistribute it and/or
477
+ modify it under the terms of the GNU Lesser General Public
478
+ License as published by the Free Software Foundation; either
479
+ version 2.1 of the License, or (at your option) any later version.
480
+
481
+ This library is distributed in the hope that it will be useful,
482
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
483
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
484
+ Lesser General Public License for more details.
485
+
486
+ You should have received a copy of the GNU Lesser General Public
487
+ License along with this library; if not, write to the Free Software
488
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
489
+
490
+ Also add information on how to contact you by electronic and paper mail.
491
+
492
+ You should also get your employer (if you work as a programmer) or your
493
+ school, if any, to sign a "copyright disclaimer" for the library, if
494
+ necessary. Here is a sample; alter the names:
495
+
496
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
497
+ library `Frob' (a library for tweaking knobs) written by James Random Hacker.
498
+
499
+ <signature of Ty Coon>, 1 April 1990
500
+ Ty Coon, President of Vice
501
+
502
+ That's all there is to it!