Functions | |
| def | valid (name, path, path_type) |
| def | compile_dfn_exe (path) |
| def | define_paths () |
Variables | |
| string | DFNPARAMS = '~/.dfnworksrc' |
Function Documentation
◆ compile_dfn_exe()
| def pydfnworks.general.paths.compile_dfn_exe | ( | path | ) |
Compile executables used in the DFN workflow including: DFNGen, DFNTrans, correct_uge, correct_stor, mesh_checking. The executables LaGriT, PFLOTRAN, and FEHM are not compiled in this function
Parameters
----------
directory : string
Path to dfnWorks executable
Returns
-------
None
Notes
-----
This function is only called if an executable is not found.
Definition at line 48 of file paths.py.
Referenced by pydfnworks.general.paths.define_paths().
Here is the caller graph for this function:
◆ define_paths()
| def pydfnworks.general.paths.define_paths | ( | ) |
Defines environmental variables for use in dfnWorks. The user must change these to match their workspace.
Parameters
----------
None
Returns
-------
None
Notes
-----
Environmental variables are set to executables
Definition at line 71 of file paths.py.
References pydfnworks.general.paths.compile_dfn_exe(), and pydfnworks.general.paths.valid().
Here is the call graph for this function:
◆ valid()
| def pydfnworks.general.paths.valid | ( | name, | |
| path, | |||
| path_type | |||
| ) |
" Check that path is valid for a executable
Parameters
----------
name : string
Path to file or executable
path_type : string
Path type can either be an executable or a directory
Returns
-------
0 if paths are valid
Notes
-----
If file is not found, file is not an executable, or directory does not exists then program exits
Definition at line 11 of file paths.py.
Referenced by pydfnworks.general.paths.define_paths().
Here is the caller graph for this function:
