options.py Added an options file which was in the archived boututils but not in the current version.

pfile.py Added an older file that we used to use for loading the pfile from the kinetic efit files.

Author: malamast

src/boututils/options.py

@@ -0,0 +1,163 @@
+"""Module to allow BOUT.inp files to be read into python and
+manipulated with ease.
+
+
+Nick Walkden, June 2015
+nick.walkden@ccfe.ac.uk
+
+"""
+
+import os
+from copy import copy
+
+
+class BOUTOptions(object):
+    """Class to store and interact with options from BOUT++
+
+    Parameters
+    ----------
+    inp_path : str, optional
+        Path to BOUT++ options file
+
+    Examples
+    --------
+
+    Instantiate with
+
+    >>> myOpts = BOUTOptions()
+    >>> myOpts.read_inp('path/to/input/file')
+
+    or
+
+    >>> myOpts = BOUTOptions('path/to/input/file')
+
+    To get a list of sections use
+
+    >>> section_list = myOpts.list_sections
+    >>> # Also print to screen:
+    >>> section_list = myOpts.list_sections(verbose=True)
+
+    Each section of the input is stored as a dictionary attribute so
+    that, if you want all the settings in the section [ddx]:
+
+    >> ddx_opt_dict = myOpts.ddx
+
+    and access individual settings by
+
+    >>> ddx_setting = myOpts.ddx['first']
+
+    Any settings in BOUT.inp without a section are stored in
+
+    >>> root_dict = myOpts.root
+
+    TODO
+    ----
+    - Merge this and BoutOptionsFile or replace with better class
+
+    """
+
+    def __init__(self, inp_path=None):
+        self._sections = ["root"]
+
+        for section in self._sections:
+            super(BOUTOptions, self).__setattr__(section, {})
+
+        if inp_path is not None:
+            self.read_inp(inp_path)
+
+    def read_inp(self, inp_path=""):
+        """Read a BOUT++ input file
+
+        Parameters
+        ----------
+        inp_path : str, optional
+            Path to the input file (default: current directory)
+
+        """
+
+        filename = os.path.join(inp_path, "BOUT.inp")
+        try:
+            inpfile = open(filename, "r")
+        except OSError:
+            raise TypeError(f"ERROR: Could not read file {filename}")
+
+        current_section = "root"
+        inplines = inpfile.read().splitlines()
+        # Close the file after use
+        inpfile.close()
+        for line in inplines:
+            # remove white space
+            line = line.replace(" ", "")
+
+            if len(line) > 0 and line[0] != "#":
+                # Only read lines that are not comments or blank
+                if "[" in line:
+                    # Section header
+                    section = line.split("[")[1].split("]")[0]
+                    current_section = copy(section)
+                    if current_section not in self._sections:
+                        self.add_section(current_section)
+
+                elif "=" in line:
+                    # option setting
+                    attribute = line.split("=")[0]
+                    value = line.split("=")[1].split("#")[0]
+                    value = value.replace("\n", "")
+                    value = value.replace("\t", "")
+                    value = value.replace("\r", "")
+                    value = value.replace('"', "")
+                    self.__dict__[copy(current_section)][copy(attribute)] = copy(value)
+                else:
+                    pass
+
+    def add_section(self, section):
+        """Add a section to the options
+
+        Parameters
+        ----------
+        section : str
+            The name of a new section
+
+        TODO
+        ----
+        - Guard against wrong type
+        """
+        self._sections.append(section)
+        super(BOUTOptions, self).__setattr__(section, {})
+
+    def remove_section(self, section):
+        """Remove a section from the options
+
+        Parameters
+        ----------
+        section : str
+            The name of a section to remove
+
+        TODO
+        ----
+        - Fix undefined variable
+        """
+        if section in self._sections:
+            self._sections.pop(self._sections.index(section))
+            super(BOUTOptions, self).__delattr__(section)
+        else:
+            print(f"WARNING: Section {section} not found.\n")
+
+    def list_sections(self, verbose=False):
+        """Return all the sections in the options
+
+        Parameters
+        ----------
+        verbose : bool, optional
+            If True, print sections to screen
+
+        TODO
+        ----
+        - Better pretty-print
+        """
+        if verbose:
+            print("Sections Contained: \n")
+            for section in self._sections:
+                print("\t{section}\n")
+
+        return self._sections