├── tests ├── __init__.py └── test_all.py ├── setup.cfg ├── namelist_python ├── namelist_python.py ├── __init__.py ├── utils.py └── namelist.py ├── .gitignore ├── .travis.yml ├── setup.py ├── README.md └── LICENSE.txt /tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.md 3 | -------------------------------------------------------------------------------- /namelist_python/namelist_python.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """Main module.""" 4 | -------------------------------------------------------------------------------- /namelist_python/__init__.py: -------------------------------------------------------------------------------- 1 | from .namelist import read_namelist_file, Namelist, AttributeMapper 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.swp 2 | *.pyc 3 | .ropeproject/ 4 | build/ 5 | dist/ 6 | *.egg-info/ 7 | *.egg/ 8 | .cache/ 9 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | 3 | python: 4 | - "2.6" 5 | - "2.7" 6 | - "3.2" 7 | - "3.3" 8 | - "3.4" 9 | - "3.5" 10 | - "nightly" 11 | 12 | script: 13 | - python setup.py test 14 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | from setuptools import setup 4 | from setuptools.command.test import test as TestCommand 5 | 6 | class PyTest(TestCommand): 7 | def run_tests(self): 8 | import shlex 9 | #import here, cause outside the eggs aren't loaded 10 | import pytest 11 | errno = pytest.main(['tests/']) 12 | sys.exit(errno) 13 | 14 | setup( 15 | name = 'namelist_python', 16 | packages = ['namelist_python'], 17 | version = '0.1.4', 18 | description = 'Fortran namelist file parser in Python', 19 | author = 'Leif Denby', 20 | author_email = 'leifdenby@gmail.com', 21 | url = 'https://github.com/leifdenby/namelist_python', 22 | download_url = 'https://github.com/leifdenby/namelist_python/archive/0.1.3.tar.gz', 23 | keywords = ['namelist', 'fortran', 'parsing'], 24 | cmdclass=dict(test=PyTest), 25 | tests_require=['pytest',], 26 | classifiers = [], 27 | ) 28 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Fortran namelist files in Python 2 | 3 | [![Build 4 | Status](https://travis-ci.org/leifdenby/namelist_python.svg?branch=master)](https://travis-ci.org/leifdenby/namelist_python) 5 | 6 | Install with `pip` 7 | 8 | pip install namelist_python 9 | 10 | Read in a namelist file: 11 | ``` 12 | from namelist_python import read_namelist_file 13 | namelist = read_namelist_file('SIM_CONFIG.nl') 14 | ``` 15 | 16 | `namelist` is an instance of `namelist_python.Namelist` and all groups are 17 | stored in the attribute `groups` with each variable in a nested dictionary 18 | structure (using `OrderedDict` so that the order will be remembered). 19 | 20 | Write a `Namelist` object back to a file: 21 | ``` 22 | with open('NEW_FILE.nl', 'w') as f: 23 | f.write(namelist.dump()) 24 | ``` 25 | 26 | `dump` takes an optional argument `array_inline` a boolean which sets whether 27 | arrays should be inline or given in index notation. 28 | 29 | If you use ipython there is usefull attribute called `data` which allows you to 30 | do tab completion on the group and variable names, and do assignment: 31 | 32 | ``` 33 | In [7]: namelist.data.ATHAM_SETUP.dt 34 | namelist.data.ATHAM_SETUP.dt 35 | namelist.data.ATHAM_SETUP.dtmax 36 | namelist.data.ATHAM_SETUP.dtmin 37 | In [7]: namelist.data.ATHAM_SETUP.dt 38 | Out[7]: 3.0 39 | 40 | In [8]: namelist.data.ATHAM_SETUP.dt = 4.0 41 | 42 | In [9]: namelist.data.ATHAM_SETUP.dt 43 | Out[9]: 4.0 44 | ``` 45 | 46 | ## Features 47 | - Parses ints, floats, booleans, escaped strings and complex numbers. 48 | - Parses arrays in index notation and inlined. 49 | - Can output in namelist format. 50 | - Tab-completion and variable assignment in interactive console 51 | 52 | ## Missing features 53 | - Currently can't handle complex variable definitions across multiple lines 54 | - Comments are not kept, and so won't exist in output. 55 | 56 | ## Contribute 57 | Please send any namelist files that don't parse correctly or fix the code 58 | yourself and send me a pull request :) 59 | 60 | Thanks, 61 | Leif 62 | -------------------------------------------------------------------------------- /namelist_python/utils.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2009 Raymond Hettinger 2 | # 3 | # Permission is hereby granted, free of charge, to any person 4 | # obtaining a copy of this software and associated documentation files 5 | # (the "Software"), to deal in the Software without restriction, 6 | # including without limitation the rights to use, copy, modify, merge, 7 | # publish, distribute, sublicense, and/or sell copies of the Software, 8 | # and to permit persons to whom the Software is furnished to do so, 9 | # subject to the following conditions: 10 | # 11 | # The above copyright notice and this permission notice shall be 12 | # included in all copies or substantial portions of the Software. 13 | # 14 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 15 | # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 16 | # OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 17 | # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 18 | # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 19 | # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 20 | # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 21 | # OTHER DEALINGS IN THE SOFTWARE. 22 | 23 | from UserDict import DictMixin 24 | 25 | class OrderedDict(dict, DictMixin): 26 | 27 | def __init__(self, *args, **kwds): 28 | if len(args) > 1: 29 | raise TypeError('expected at most 1 arguments, got %d' % len(args)) 30 | try: 31 | self.__end 32 | except AttributeError: 33 | self.clear() 34 | self.update(*args, **kwds) 35 | 36 | def clear(self): 37 | self.__end = end = [] 38 | end += [None, end, end] # sentinel node for doubly linked list 39 | self.__map = {} # key --> [key, prev, next] 40 | dict.clear(self) 41 | 42 | def __setitem__(self, key, value): 43 | if key not in self: 44 | end = self.__end 45 | curr = end[1] 46 | curr[2] = end[1] = self.__map[key] = [key, curr, end] 47 | dict.__setitem__(self, key, value) 48 | 49 | def __delitem__(self, key): 50 | dict.__delitem__(self, key) 51 | key, prev, next = self.__map.pop(key) 52 | prev[2] = next 53 | next[1] = prev 54 | 55 | def __iter__(self): 56 | end = self.__end 57 | curr = end[2] 58 | while curr is not end: 59 | yield curr[0] 60 | curr = curr[2] 61 | 62 | def __reversed__(self): 63 | end = self.__end 64 | curr = end[1] 65 | while curr is not end: 66 | yield curr[0] 67 | curr = curr[1] 68 | 69 | def popitem(self, last=True): 70 | if not self: 71 | raise KeyError('dictionary is empty') 72 | if last: 73 | key = reversed(self).next() 74 | else: 75 | key = iter(self).next() 76 | value = self.pop(key) 77 | return key, value 78 | 79 | def __reduce__(self): 80 | items = [[k, self[k]] for k in self] 81 | tmp = self.__map, self.__end 82 | del self.__map, self.__end 83 | inst_dict = vars(self).copy() 84 | self.__map, self.__end = tmp 85 | if inst_dict: 86 | return (self.__class__, (items,), inst_dict) 87 | return self.__class__, (items,) 88 | 89 | def keys(self): 90 | return list(self) 91 | 92 | setdefault = DictMixin.setdefault 93 | update = DictMixin.update 94 | pop = DictMixin.pop 95 | values = DictMixin.values 96 | items = DictMixin.items 97 | iterkeys = DictMixin.iterkeys 98 | itervalues = DictMixin.itervalues 99 | iteritems = DictMixin.iteritems 100 | 101 | def __repr__(self): 102 | if not self: 103 | return '%s()' % (self.__class__.__name__,) 104 | return '%s(%r)' % (self.__class__.__name__, self.items()) 105 | 106 | def copy(self): 107 | return self.__class__(self) 108 | 109 | @classmethod 110 | def fromkeys(cls, iterable, value=None): 111 | d = cls() 112 | for key in iterable: 113 | d[key] = value 114 | return d 115 | 116 | def __eq__(self, other): 117 | if isinstance(other, OrderedDict): 118 | if len(self) != len(other): 119 | return False 120 | for p, q in zip(self.items(), other.items()): 121 | if p != q: 122 | return False 123 | return True 124 | return dict.__eq__(self, other) 125 | 126 | def __ne__(self, other): 127 | return not self == other 128 | -------------------------------------------------------------------------------- /tests/test_all.py: -------------------------------------------------------------------------------- 1 | import re 2 | 3 | from namelist_python import Namelist 4 | 5 | 6 | def test_single_value(): 7 | input_str = """ 8 | &CCFMSIM_SETUP 9 | CCFMrad=800.0 10 | / 11 | """ 12 | namelist = Namelist(input_str) 13 | 14 | expected_output = {'CCFMSIM_SETUP': { 'CCFMrad': 800. }} 15 | 16 | assert namelist.groups == expected_output 17 | 18 | def test_multigroup(): 19 | input_str = """ 20 | &CCFMSIM_SETUP 21 | CCFMrad=800.0 22 | / 23 | &GROUP2 24 | R=500.0 25 | / 26 | """ 27 | namelist = Namelist(input_str) 28 | 29 | expected_output = {'CCFMSIM_SETUP': { 'CCFMrad': 800. }, 30 | 'GROUP2': { 'R': 500. }} 31 | 32 | assert namelist.groups == expected_output 33 | 34 | def test_comment(): 35 | input_str = """ 36 | ! Interesting comment at the start 37 | &CCFMSIM_SETUP 38 | CCFMrad=800.0 39 | ! And a comment some where in the middle 40 | / 41 | &GROUP2 42 | R=500.0 43 | / 44 | """ 45 | namelist = Namelist(input_str) 46 | 47 | expected_output = {'CCFMSIM_SETUP': { 'CCFMrad': 800. }, 48 | 'GROUP2': { 'R': 500. }} 49 | 50 | assert namelist.groups == expected_output 51 | 52 | def test_array(): 53 | input_str = """ 54 | &CCFMSIM_SETUP 55 | ntrac_picture=4 56 | var_trac_picture(1)='watcnew' 57 | des_trac_picture(1)='cloud_water' 58 | var_trac_picture(2)='watpnew' 59 | des_trac_picture(2)='rain' 60 | var_trac_picture(3)='icecnew' 61 | des_trac_picture(3)='cloud_ice' 62 | var_trac_picture(4)='granew' 63 | des_trac_picture(4)='graupel' 64 | / 65 | """ 66 | namelist = Namelist(input_str) 67 | 68 | expected_output = { 69 | 'CCFMSIM_SETUP': { 70 | 'ntrac_picture': 4, 71 | 'var_trac_picture': [ 72 | 'watcnew', 73 | 'watpnew', 74 | 'icecnew', 75 | 'granew', 76 | ], 77 | 'des_trac_picture': [ 78 | 'cloud_water', 79 | 'rain', 80 | 'cloud_ice', 81 | 'graupel', 82 | ], 83 | }, 84 | } 85 | 86 | assert dict(namelist.groups) == expected_output 87 | 88 | def test_boolean_sciformat(): 89 | input_str = """ 90 | &ATHAM_SETUP 91 | 92 | nz =300 93 | zstart =0. 94 | ztotal =15000. 95 | dzzoom =50. 96 | kcenter =20 97 | nztrans =0 98 | nztrans_boundary =6 99 | 100 | cpumax =9.e6 101 | 102 | no_uwind=.false. 103 | no_vwind=.true. 104 | / 105 | """ 106 | namelist = Namelist(input_str) 107 | 108 | expected_output = { 109 | 'ATHAM_SETUP': { 110 | 'nz': 300, 111 | 'zstart': 0., 112 | 'ztotal': 15000., 113 | 'dzzoom': 50., 114 | 'kcenter': 20, 115 | 'nztrans': 0, 116 | 'nztrans_boundary': 6, 117 | 'cpumax': 9.e6, 118 | 'no_uwind': False, 119 | 'no_vwind': True, 120 | } 121 | } 122 | 123 | assert dict(namelist.groups) == expected_output 124 | 125 | def test_comment_with_forwardslash(): 126 | input_str = """ 127 | ! Interesting comment at the start 128 | &CCFMSIM_SETUP 129 | CCFMrad=800.0 130 | ! And a comment some where in the middle/halfway ! 131 | var2=40 132 | / 133 | &GROUP2 134 | R=500.0 135 | / 136 | """ 137 | namelist = Namelist(input_str) 138 | 139 | expected_output = {'CCFMSIM_SETUP': { 'CCFMrad': 800., 'var2': 40 }, 140 | 'GROUP2': { 'R': 500. }} 141 | 142 | assert namelist.groups == expected_output 143 | 144 | def test_inline_array(): 145 | input_str = """ 146 | ! can have blank lines and comments in the namelist input file 147 | ! place these comments between NAMELISTs 148 | 149 | ! 150 | ! not every compiler supports comments within the namelist 151 | ! in particular vastf90/g77 does not 152 | ! 153 | ! some will skip NAMELISTs not directly referenced in read 154 | !&BOGUS rko=1 / 155 | ! 156 | &TTDATA 157 | TTREAL = 1., 158 | TTINTEGER = 2, 159 | TTCOMPLEX = (3.,4.), 160 | TTCHAR = 'namelist', 161 | TTBOOL = T/ 162 | &AADATA 163 | AAREAL = 1. 1. 2. 3., 164 | AAINTEGER = 2 2 3 4, 165 | AACOMPLEX = (3.,4.) (3.,4.) (5.,6.) (7.,7.), 166 | AACHAR = 'namelist' 'namelist' 'array' ' the lot', 167 | AABOOL = T T F F/ 168 | &XXDATA 169 | XXREAL = 1., 170 | XXINTEGER = 2, 171 | XXCOMPLEX = (3.,4.)/! can have blank lines and comments in the namelist input file 172 | """ 173 | 174 | expected_output = { 175 | 'TTDATA': { 176 | 'TTREAL': 1., 177 | 'TTINTEGER': 2, 178 | 'TTCOMPLEX': 3. + 4.j, 179 | 'TTCHAR': 'namelist', 180 | 'TTBOOL': True, 181 | }, 182 | 'AADATA': { 183 | 'AAREAL': [1., 1., 2., 3.,], 184 | 'AAINTEGER': [2, 2, 3, 4], 185 | 'AACOMPLEX': [3.+4.j, 3.+4.j, 5.+6.j, 7.+7.j], 186 | 'AACHAR': ['namelist', 'namelist', 'array', ' the lot'], 187 | 'AABOOL': [True, True, False, False], 188 | }, 189 | 'XXDATA': { 190 | 'XXREAL': 1., 191 | 'XXINTEGER': 2., 192 | 'XXCOMPLEX': 3.+4.j, 193 | }, 194 | } 195 | 196 | namelist = Namelist(input_str) 197 | 198 | assert dict(namelist.groups) == expected_output 199 | 200 | 201 | def test_inline_array_comma(): 202 | input_str = """ 203 | &foo 204 | bar = 7.2, 4.3, 3.14, 205 | / 206 | """ 207 | expected_output = {'foo': {'bar':[7.2, 4.3, 3.14]}} 208 | namelist = Namelist(input_str) 209 | 210 | assert dict(namelist.groups) == expected_output 211 | 212 | 213 | def test_dump_single_value(): 214 | input_str = """&CCFMSIM_SETUP 215 | CCFMrad = 800. 216 | /""" 217 | namelist = Namelist(input_str) 218 | 219 | assert namelist.dump() == input_str 220 | 221 | 222 | def test_inline_comment(): 223 | input_str = """&CCFMSIM_SETUP 224 | CCFMrad = 800. ! foobar 225 | /""" 226 | namelist = Namelist(input_str) 227 | 228 | expected_output = {'CCFMSIM_SETUP': { 'CCFMrad': 800., },} 229 | 230 | assert namelist.groups == expected_output 231 | 232 | def test_dump_multigroup(): 233 | input_str = """&CCFMSIM_SETUP 234 | CCFMrad = 800. 235 | / 236 | &GROUP2 237 | R = 500. 238 | /""" 239 | namelist = Namelist(input_str) 240 | 241 | assert namelist.dump() == input_str 242 | 243 | def test_commongroup_names(): 244 | re_common = re.compile(r'RELEASE') 245 | input_str = """&REL_CTRL 246 | NSPEC= 1, 247 | SPECNUM_REL= 100, 248 | / 249 | &RELEASE 250 | IDATE1= 20100101, 251 | ITIME1= 000000, 252 | IDATE2= 20100201, 253 | ITIME2= 000000, 254 | / 255 | &RELEASE 256 | IDATE1= 20100101, 257 | ITIME1= 000000, 258 | IDATE2= 20100201, 259 | ITIME2= 000000, 260 | /""" 261 | namelist = Namelist(input_str) 262 | common1 = re.findall(re_common, input_str) 263 | common2 = re.findall(re_common, namelist.dump(array_inline=False)) 264 | 265 | assert common1 == common2 266 | 267 | def test_dump_path(): 268 | input_str = """&settings 269 | path = '/home/monkey/' 270 | /""" 271 | namelist = Namelist(input_str) 272 | 273 | assert namelist.dump(array_inline=False) == input_str 274 | 275 | def test_dump_array(): 276 | input_str = """&CCFMSIM_SETUP 277 | var_trac_picture(1) = 'watcnew' 278 | var_trac_picture(2) = 'watpnew' 279 | var_trac_picture(3) = 'icecnew' 280 | var_trac_picture(4) = 'granew' 281 | des_trac_picture(1) = 'cloud_water' 282 | des_trac_picture(2) = 'rain' 283 | des_trac_picture(3) = 'cloud_ice' 284 | des_trac_picture(4) = 'graupel' 285 | /""" 286 | namelist = Namelist(input_str) 287 | 288 | assert namelist.dump(array_inline=False) == input_str 289 | 290 | def test_dump_inline_array(): 291 | input_str = """&AADATA 292 | AACOMPLEX = (3.,4.) (3.,4.) (5.,6.) (7.,7.) 293 | /""" 294 | 295 | namelist = Namelist(input_str) 296 | 297 | assert namelist.dump() == input_str 298 | 299 | def test_multiline_variable(): 300 | input_str = """&AADATA 301 | AACOMPLEX = 3., 4., 3., 4., 302 | 5., 6., 7., 7. 303 | /""" 304 | 305 | namelist = Namelist(input_str) 306 | 307 | assert namelist.groups == {'AADATA': {'AACOMPLEX': 308 | [3., 4., 3., 4., 5., 6., 7., 7.]}} 309 | -------------------------------------------------------------------------------- /namelist_python/namelist.py: -------------------------------------------------------------------------------- 1 | import sys 2 | try: 3 | from collections import OrderedDict 4 | except ImportError: 5 | from utils import OrderedDict 6 | 7 | import re 8 | 9 | class NoSingleValueFoundException(Exception): 10 | pass 11 | 12 | def read_namelist_file(filename): 13 | return Namelist(open(filename, 'r').read()) 14 | 15 | 16 | class AttributeMapper(): 17 | """ 18 | Simple mapper to access dictionary items as attributes 19 | """ 20 | 21 | def __init__(self, obj): 22 | self.__dict__['data'] = obj 23 | 24 | def __getattr__(self, attr): 25 | if attr in self.data: 26 | found_attr = self.data[attr] 27 | if isinstance(found_attr, dict): 28 | return AttributeMapper(found_attr) 29 | else: 30 | return found_attr 31 | else: 32 | raise AttributeError 33 | 34 | def __setattr__(self, attr, value): 35 | if attr in self.data: 36 | self.data[attr] = value 37 | else: 38 | raise NotImplementedError 39 | 40 | def __dir__(self): 41 | return self.data.keys() 42 | 43 | class Namelist(): 44 | """ 45 | Parses namelist files in Fortran 90 format, recognised groups are 46 | available through 'groups' attribute. 47 | """ 48 | 49 | def __init__(self, input_str): 50 | self.groups = OrderedDict() 51 | 52 | group_re = re.compile(r'&([^&]+)/', re.DOTALL) # allow blocks to span multiple lines 53 | array_re = re.compile(r'(\w+)\((\d+)\)') 54 | string_re = re.compile(r"\'\s*\w[^']*\'") 55 | self._complex_re = re.compile(r'^\((\d+.?\d*),(\d+.?\d*)\)$') 56 | 57 | # remove all comments, since they may have forward-slashes 58 | # TODO: store position of comments so that they can be re-inserted when 59 | # we eventually save 60 | filtered_lines = [] 61 | for line in input_str.split('\n'): 62 | if line.strip().startswith('!'): 63 | continue 64 | else: 65 | filtered_lines.append(line) 66 | 67 | group_blocks = re.findall(group_re, "\n".join(filtered_lines)) 68 | 69 | group_cnt = {} 70 | 71 | for group_block in group_blocks: 72 | block_lines_raw = group_block.split('\n') 73 | group_name = block_lines_raw.pop(0).strip() 74 | 75 | group = OrderedDict() 76 | 77 | block_lines = [] 78 | for line in block_lines_raw: 79 | # cleanup string 80 | line = line.strip() 81 | if line == "": 82 | continue 83 | if line.startswith('!'): 84 | continue 85 | 86 | try: 87 | k, v = line.split('=') 88 | block_lines.append(line) 89 | except ValueError: 90 | # no = in current line, try to append to previous line 91 | if block_lines[-1].endswith(','): 92 | block_lines[-1] += line 93 | else: 94 | raise 95 | 96 | for line in block_lines: 97 | # commas at the end of lines seem to be optional 98 | if line.endswith(','): 99 | line = line[:-1] 100 | 101 | # inline comments are allowed, but we remove them for now 102 | if "!" in line: 103 | line = line.split("!")[0].strip() 104 | 105 | k, v = line.split('=') 106 | variable_name = k.strip() 107 | variable_value = v.strip() 108 | 109 | variable_name_groups = re.findall(array_re, k) 110 | 111 | variable_index = None 112 | if len(variable_name_groups) == 1: 113 | variable_name, variable_index = variable_name_groups[0] 114 | variable_index = int(variable_index)-1 # python indexing starts at 0 115 | 116 | try: 117 | parsed_value = self._parse_value(variable_value) 118 | 119 | if variable_index is None: 120 | group[variable_name] = parsed_value 121 | else: 122 | if not variable_name in group: 123 | group[variable_name] = {'_is_list': True} 124 | group[variable_name][variable_index] = parsed_value 125 | 126 | except NoSingleValueFoundException as e: 127 | # see we have several values inlined 128 | if variable_value.count("'") in [0, 2]: 129 | if variable_value.count("(") != 0: # if list of complex values 130 | variable_arr_entries = variable_value.split() 131 | else: 132 | # replacing ',' makes comma-separated arrays possible, 133 | # see unit test test_inline_array_comma 134 | # this fails if an array of complex numbers is comma-separated 135 | variable_arr_entries = variable_value.replace(',', ' ').split() 136 | else: 137 | # we need to be more careful with lines with escaped 138 | # strings, since they might contained spaces 139 | matches = re.findall(string_re, variable_value) 140 | variable_arr_entries = [s.strip() for s in matches] 141 | 142 | 143 | for variable_index, inline_value in enumerate(variable_arr_entries): 144 | parsed_value = self._parse_value(inline_value) 145 | 146 | if variable_index is None: 147 | group[variable_name] = parsed_value 148 | else: 149 | if not variable_name in group: 150 | group[variable_name] = {'_is_list': True} 151 | group[variable_name][variable_index] = parsed_value 152 | 153 | if group_name in self.groups.keys(): 154 | 155 | if not group_name in group_cnt.keys(): 156 | group_cnt[group_name] = 0 157 | else: 158 | group_cnt[group_name] += 1 159 | group_name = group_name + str(group_cnt[group_name]) 160 | 161 | self.groups[group_name] = group 162 | 163 | self._check_lists() 164 | 165 | def _parse_value(self, variable_value): 166 | """ 167 | Tries to parse a single value, raises an exception if no single value is matched 168 | """ 169 | try: 170 | parsed_value = int(variable_value) 171 | except ValueError: 172 | try: 173 | parsed_value = float(variable_value) 174 | except ValueError: 175 | # check for complex number 176 | complex_values = re.findall(self._complex_re, variable_value) 177 | if len(complex_values) == 1: 178 | a, b = complex_values[0] 179 | parsed_value = complex(float(a),float(b)) 180 | elif variable_value in ['.true.', 'T']: 181 | # check for a boolean 182 | parsed_value = True 183 | elif variable_value in ['.false.', 'F']: 184 | parsed_value = False 185 | else: 186 | # see if we have an escaped string 187 | if variable_value.startswith("'") and variable_value.endswith("'") and variable_value.count("'") == 2: 188 | parsed_value = variable_value[1:-1] 189 | elif variable_value.startswith('"') and variable_value.endswith('"') and variable_value.count('"') == 2: 190 | parsed_value = variable_value[1:-1] 191 | else: 192 | raise NoSingleValueFoundException(variable_value) 193 | 194 | return parsed_value 195 | 196 | def _check_lists(self): 197 | for group in self.groups.values(): 198 | for variable_name, variable_values in group.items(): 199 | if isinstance(variable_values, dict): 200 | if '_is_list' in variable_values and variable_values['_is_list']: 201 | variable_data = variable_values 202 | del(variable_data['_is_list']) 203 | 204 | num_entries = len(variable_data.keys()) 205 | variable_list = [None]*num_entries 206 | 207 | for i, value in variable_data.items(): 208 | if i >= num_entries: 209 | raise Exception("The variable '%s' has an array index assignment that is inconsistent with the number of list values" % variable) 210 | else: 211 | variable_list[i] = value 212 | 213 | group[variable_name] = variable_list 214 | 215 | def dump(self, array_inline=True): 216 | lines = [] 217 | for group_name, group_variables in self.groups.items(): 218 | lines.append("&%s" % group_name) 219 | for variable_name, variable_value in group_variables.items(): 220 | if isinstance(variable_value, list): 221 | if array_inline: 222 | lines.append(" %s = %s" % (variable_name, " ".join([self._format_value(v) for v in variable_value]))) 223 | else: 224 | for n, v in enumerate(variable_value): 225 | lines.append(" %s(%d) = %s" % (variable_name, n+1, self._format_value(v))) 226 | else: 227 | lines.append(" %s = %s" % (variable_name, self._format_value(variable_value))) 228 | lines.append("/") 229 | 230 | return "\n".join(lines) + "\n" 231 | 232 | def _format_value(self, value): 233 | is_python2 = sys.version_info < (3,0,0) 234 | if isinstance(value, bool): 235 | return value and '.true.' or '.false.' 236 | elif isinstance(value, int): 237 | return "%d" % value 238 | elif isinstance(value, float): 239 | # ensure that we never use scientific notation, but remove excess zeroes 240 | # https://stackoverflow.com/a/2440786 241 | return ('%f' % value).rstrip('0') 242 | elif isinstance(value, str): 243 | return "'%s'" % value 244 | elif is_python2 and isinstance(value, unicode): # needed if unicode literals are used 245 | return "'%s'" % value 246 | elif isinstance(value, complex): 247 | return "(%s,%s)" % (self._format_value(value.real), self._format_value(value.imag)) 248 | else: 249 | raise Exception("Variable type not understood: %s" % type(value)) 250 | 251 | @property 252 | def data(self): 253 | return AttributeMapper(self.groups) 254 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------