Commit 9f0c8d3c authored by Patrick Shriwise's avatar Patrick Shriwise
Browse files

Updating docstrings for PyGriffin.run

parent d289a344

pygriffin/pygriffin.py

+10 −1
Original line number Diff line number Diff line
@@ -31,8 +31,17 @@ class PyGriffin: 


        Parameters

        ----------

        cwd : str or Path

        input : str or pathlib.Path object

            Griffin input file

        mesh : str or pathlib.Path object

            Location of the griffin mesh (either input or exodus)

        cwd : str or  pathlib.Path object

            Directory from which to run Griffin

        other_args : Iterable of str

            Other arguments to provide to the command line

        color : bool

            Removes posix terminal color characters from Griffin output

            if False



        Returns

        -------