Skip to main content

Parsing Fortran namelists to Python dictionaries and back.

Project description

pipeline status coverage report

py-namelist

Parse Fortran Namelists to dict-like objects and back

Download

To get the latest release do

git clone https://git.geomar.de:martin-claus/py-namelist.git --branch v0.1.0 --depth=1

or, if you prefer the latest unstable version

git clone https://git.geomar.de:martin-claus/py-namelist.git

Usage

To parse a namelist file you call parse_namelist_file(fobj) where fobj is a file-like object offering a read() and seek() method (usually the standard python file object). Alternatively, you can parse a string using parse_namelist_string(str).

import namelist
with open(your_nml_file) as fobj:
	nmls = namelist.parse_namelist_file(fobj)

nmls will be a list of instances of the Namelist class.

Namelist is a subclass of OrderedDict (or dict if you use Python < 2.7). A Namelist instance, nml, is initialized with an name and optionally with initial values.

nml = Namelist("param", (("key1", val1), ...))

The name attribute will set the read-only property name of nml. To change, add or delete values the same methods are available as for dict.

print nml.name
nml.update({"eggs": 1, "spam": [1, 2, 3]})
del(nml["param"])

To create a Fortran readable string representation of the Namelist instance, just use the str() build-in

s = str(nml)

or just

print(nml)

A string representation of the Namelist instance that can be used by eval() to create copies of it can be created by repr()

print repr(nml)

Note: The parsing of namelist does not have to strictly follow the Fortran standard. Hence, some namelists that are perfectly accepted by some Fortran version are not guaranteed to be correctly parsed by parse_namelist_string(). Always check the content of your Namelist object. If you do find a namelist that does not work, please create an issue at https://git.geomar.de/martin-claus/py-namelist/ together with the namelist that does not work.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

namelist-0.1.0.tar.gz (4.3 kB view hashes)

Uploaded Source

Built Distribution

namelist-0.1.0-py3-none-any.whl (11.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page