omfit-namelist 2020.12.2.22.59
omfit_namelist
Requires Python: >=3.6

**NAMELIST** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITnamelist
* OMFITfortranNamelist
* fortran_environment
* sparray

Requires:
=========
* numpy>=1.12
* uncertainties>=3
* omfit_ascii==2020.12.2.22.59
* omfit_path==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITnamelist
-------------

    OMFIT class used to interface with FORTRAN namelist files
    
    :param filename: filename to be parsed

    :param input_string: input string to be parsed (preceeds filename)

    :param nospaceIsComment: whether a line which starts without a space should be retained as a comment. If None, a "smart" guess is attempted

    :param outsideOfNamelistIsComment: whether the content outside of the namelist blocks should be retained as comments. If None, a "smart" guess is attempted

    :param retain_comments: whether comments should be retained or discarded

    :param skip_to_symbol: string to jump to for the parsing. Content before this string is ignored

    :param collect_arrays: whether arrays defined throughout the namelist should be collected into single entries
     (e.g. a=5,a(1,4)=0)

    :param multiDepth: wether nested namelists are allowed

    :param bang_comment_symbol: string containing the characters that should be interpreted as comment delimiters.

    :param equals: how the equal sign should be written when saving the namelist

    :param compress_arrays: compress repeated elements in an array by using v*n namelist syntax

    :param max_array_chars: wrap long array lines

    :param explicit_arrays: (True,False,1) whether to place `name(1)` in front of arrays.
                            If `1` then (1) is only placed in front of arrays that have only one value.

    :param separator_arrays: characters to use between array elements

    :param split_arrays: write each array element explicitly on a separate line
                         Specifically this functionality was introduced to split TRANSP arrays

    :param idlInput: whether to interpret the namelist as IDL code

OMFITfortranNamelist
--------------------

    OMFIT class used to interface with FORTRAN namelist files with arrays indexed according to FORTRAN indexing convention
        
    :param filename: filename to be parsed

    :param input_string: input string to be parsed (preceeds filename)

    :param nospaceIsComment: whether a line which starts without a space should be retained as a comment. If None, a "smart" guess is attempted

    :param outsideOfNamelistIsComment: whether the content outside of the namelist blocks should be retained as comments. If None, a "smart" guess is attempted

    :param retain_comments: whether comments should be retained or discarded

    :param skip_to_symbol: string to jump to for the parsing. Content before this string is ignored

    :param collect_arrays: whether arrays defined throughout the namelist should be collected into single entries
     (e.g. a=5,a(1,4)=0)

    :param multiDepth: wether nested namelists are allowed

    :param bang_comment_symbol: string containing the characters that should be interpreted as comment delimiters.

    :param equals: how the equal sign should be written when saving the namelist

    :param compress_arrays: compress repeated elements in an array by using v*n namelist syntax

    :param max_array_chars: wrap long array lines

    :param explicit_arrays: (True,False,1) whether to place `name(1)` in front of arrays.
                            If `1` then (1) is only placed in front of arrays that have only one value.

    :param separator_arrays: characters to use between array elements

    :param split_arrays: write each array element explicitly on a separate line
                         Specifically this functionality was introduced to split TRANSP arrays

    :param idlInput: whether to interpret the namelist as IDL code

fortran_environment
-------------------

    Environment class used to allow FORTRAN index convention of sparrays in a namelist
    

sparray
-------

    Class for n-dimensional sparse array objects using Python's dictionary structure.
    based upon: http://www.janeriksolem.net/2010/02/sparray-sparse-n-dimensional-arrays-in.html