f90nml 0.10.1

Fortran 90 namelist parser

A Python module for parsing Fortran namelist files

About f90nml

The f90nml module takes a Fortran 90 namelist file and parses it into a Python dict of namelist groups, each containing a dict of its variables. Fortran data types are converted to equivalent Python types.

Usage

To read a Fortran namelist file as a dict, use the read() method:

nml = f90nml.read(nml_filename)

To save a dict as a Fortran namelist file, use the write() method:

nml.write(output_filename)

The write() method will abort if the output file already exists.

To patch an existing file against a dict, use the patch() method:

nml.patch(input_filename, nml_patch, output_filename)

Namelist fields in input_filename will be checked against nml_patch and updated with new values. Fields in nml_patch which do not exist in input_filename will be appended to the namelist groups. The function returns the updated namelist dict and saves the patched namelist file to output_filename.

The patch() method currently does not allow patching of vectors or user types (%), but may be included in the future.

Additional Features

Derived types

Additional NmlDicts are created to traverse user-defined types. For example, if you want to access z in the following namelist:

&dtype_nml
   x%y%z = 1
/

then z can be accessed in the equivalent namelist nml by typing

z = nml['dtype_nml']['x']['y']['z']

Overwriting an existing file

To overwrite an existing file when using the write method, use the force flag:

nml.write(nml_filename, force=True)

Notes

The read method produces an NmlDict, which behaves as a dict with case-insensitive keys, due to the case insensitivity of Fortran. This implementation is currently not a true case-insensitive dict, and is only intended to accommodate individual references and assignments.

In a Fortran executable, the data types of values in the namelist files are set by the corresponding variables within the program, and cannot in general be determined from the namelist file alone. Therefore, f90nml only makes an approximate guess about its data type.

The following namelist features are currently not supported:

• Multidimensional vector assignment (v(:,:) = 1, 2, 3, 4)

• Upcast vector elements if components differ (x(i) = 1, x(j) = 2.0)

• stdin/stdout support (?, ?=)

Licensing

f90nml is distributed under the Apache 2.0 License.

Contact

Marshall Ward <[e-mail]>