<commit_before>"""
module __GenericVisualization__: Base class to visualize networks
==================================================================

.. warning:: The classes of this module should be loaded through the 'Visualization/__init__.py' file.

"""

import OpenPNM
import scipy as sp
import numpy as np

class VTK(OpenPNM.Utilities.OpenPNMbase):
    r"""
    writeVTK - Class for writing a VTK file
    
    Parameters
    ----------
    
    Examples
    --------
    >>> print 'nothing yet'
    
    .. note:: 
    n/a
    
    """
    
    def __init__(self):
        r"""
        Initialize
        """
        super(VTK,self).__init__()
        
    def write(self,net=None, filename='testvtp.vtp', scaling_factor=1):
        <commit_msg>Added documentation and logger to the __VTK__ file<commit_after>"""
module __GenericVisualization__: Base class to visualize networks
==================================================================

.. warning:: The classes of this module should be loaded through the 'Visualization/__init__.py' file.

"""

import OpenPNM
import scipy as sp
import numpy as np

class VTK(OpenPNM.Utilities.OpenPNMbase):
    r"""
    writeVTK - Class for writing a VTK file
    
    Parameters
    ----------
    
    Examples
    --------
    >>> print 'nothing yet'
    
    .. note:: 
    n/a
    
    """
    
    def __init__(self,**kwargs):
        r"""
        Initialize
        """
        super(VTK,self).__init__(**kwargs)
        self._logger.debug("Execute constructor")
       
    def write(self,net=None, filename='testvtp.vtp', scaling_factor=1):
        r"""
        Write Network to a VTK file for visualizing in Paraview
        
        Parameters
        ----------
        net : OpenPNM Network Object
        
        filename : string
            Full path to desired file location
        
        scaling_factor : int, optional
            Not sure what this does
        """
        self._logger.info("Writing VTK File...please wait")        
{'fraction_non_alphanumeric': 0.17105917454002983, 'fraction_numerical': 0.000994530084535057, 'mean_word_length': 2.1097372488408035, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7636909', 'n_tokens_mistral': 549, 'n_tokens_neox': 537, 'n_words': 159}