Skip to content

feat(bar2vtk): Add toml support#49

Merged
jrwrigh merged 18 commits intomasterfrom
feat/bar2vtk-toml
Feb 10, 2021
Merged

feat(bar2vtk): Add toml support#49
jrwrigh merged 18 commits intomasterfrom
feat/bar2vtk-toml

Conversation

@jrwrigh
Copy link
Copy Markdown
Member

@jrwrigh jrwrigh commented Feb 9, 2021

Use toml documents as configuration files for bar2vtk and as "receipt" files to keep track of how a file was created. Todo:

Receipt should contain:

  • bar2vtk input arguments
  • Date/time when file was created
  • Directory where file was run from
  • Package version info
    • vtkpytools
    • pyvista
    • vtk
    • python
  • Location of source *bar files
  • Information about machine where it was run

General toml functionality

  • Allow for toml file to be used as input
  • Print out blank toml
    • Have commented instructions in blank toml
  • [ ]

Closes #34

 - The actual computation and argument parsing for bar2vtk has been
   split
 - Moved all the argparse code to a separate function
 - Note: this commit was created after many other changes. Thus the
   commit might not be completely stand alone
 - Also moved bar2vtk script functionality into bar2vtk_bin
 - Renamed bar2vtk to bar2vtk_function
 - Could not manage to get using `bar2vtk toml blank` to work
   simultaneously with `bar2vtk toml`
 - Functionality replaced with -b/--blank flag
 - Have tomlReceipt keep the vtmPath metadata
 - Rename the vtk.VTK_VERSION toml key to be consistent with other
   version keys
 - Change error messages that reference command flags to instead just
   reference the argument name: "--velbar" => "velbar"
 - Can read arguments from toml file
 - Converts arguments to correct type
 - With move to toml, the name of positional arguments matters
   significantly more
@jrwrigh jrwrigh merged commit 7a91855 into master Feb 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write "receipt" files on vtk file creation

1 participant