pydfnworks.general.dfnworks Namespace Reference

Data Structures
class	DFNWORKS

Functions
def	commandline_options ()
def	create_dfn ()

Function Documentation

commandline_options()

def pydfnworks.general.dfnworks.commandline_options

(

)

Read command lines for use in dfnWorks.

Parameters
----------
    None

Returns
---------
    options : argparse function
        command line options 

Notes
---------
    Options:
        -name : string
            Path to working directory (Mandatory) 
        -ncpu : int 
            Number of CPUS (Optional, default=4)
        -input : string 
            Input file with paths to run files (Mandatory if the next three options are not specified)
        -prune_file : string
            Absolute path to the prune Input File 
        -path : string
            Path to another DFN run that you want to base the current run from 
        -cell : bool
            True/False Set True for use with cell based aperture and permeabuility (Optional, default=False)

Definition at line 141 of file dfnworks.py.

Referenced by pydfnworks.general.dfnworks.create_dfn().

Here is the caller graph for this function:

create_dfn()

def pydfnworks.general.dfnworks.create_dfn

(

)

Parse command line inputs and input files to create and populate dfnworks class

Parameters
----------
    None

Returns
-------
    DFN : object 
        DFN class object populated with information parsed from the command line. Information about DFN class is in dfnworks.py

Notes
-----
None

Definition at line 212 of file dfnworks.py.

References pydfnworks.general.dfnworks.commandline_options().

Here is the call graph for this function: