VTKpytools/Bar2vtk - Revision history

Jrwrigh: Jrwrigh moved page Bar2vtk to VTKpytools/Bar2vtk: Move to a subpage organization

2022-09-18T17:57:57Z

Jrwrigh moved page Bar2vtk to VTKpytools/Bar2vtk: Move to a subpage organization

Jrwrigh at 17:17, 18 September 2022

2022-09-18T17:17:51Z

Jrwrigh: Add Python Category

2022-09-18T17:17:09Z

Add Python Category

Jrwrigh: /* Functionality */ Add explicit commands for modes

2021-03-11T16:38:54Z

‎Functionality: Add explicit commands for modes

Jrwrigh: Add bar2vtk flowchart

2021-03-05T19:10:57Z

Add bar2vtk flowchart

Jrwrigh at 22:00, 4 March 2021

2021-03-04T22:00:17Z

Jrwrigh at 20:53, 4 March 2021

2021-03-04T20:53:39Z

Jrwrigh: Update documentation with toml examples

2021-03-04T20:12:34Z

Update documentation with toml examples

Jrwrigh: start toml section

2021-02-28T02:27:26Z

start toml section

Jrwrigh at 02:23, 28 February 2021

2021-02-28T02:23:48Z

← Older revision		Revision as of 17:17, 18 September 2022
Line 199:		Line 199:

	[[Category:VTKpytools]]		[[Category:VTKpytools]]
		+	[[Category:Post-processing]]
	[[Category:Python]]		[[Category:Python]]

← Older revision		Revision as of 17:17, 18 September 2022
Line 199:		Line 199:

	[[Category:VTKpytools]]		[[Category:VTKpytools]]
		+	[[Category:Python]]

@@ Line 8: / Line 8: @@
 === Modes ===
-<code>bar2vtk</code> has two primary modes; cli (short for ''command line interface'') and toml. They have equal capabilities. The cli operates solely on the command line via standard flag and argument system. The toml system uses configuration files (in a [https://toml.io/en/ toml] format) to control the program instead.
+<code>bar2vtk</code> has two primary modes; cli (short for ''command line interface'') and toml. They have equal capabilities and can be called by <code>bar2vtk cli</code> and <code>bar2vtk toml</code>, respectively. The cli operates solely on the command line via standard flag and argument system. The toml system uses configuration files (in a [https://toml.io/en/ toml] format) to control the program instead.
 Below is a equivalency table for cli flags/arguments vs toml config declarations. A more detailed description for each option is given in [[Bar2vtk#Options|Options]].

← Older revision		Revision as of 19:10, 5 March 2021
Line 2:		Line 2:

	Documentation for <code>bar2vtk</code> can be found by running the <code>--help</code> flag, but this will also serve as a more detailed/verbose documentation page as well.		Documentation for <code>bar2vtk</code> can be found by running the <code>--help</code> flag, but this will also serve as a more detailed/verbose documentation page as well.
		+
		+	[[File:Vtkpytools flowchart-Using bar2vtk.png\|right]]

	== Functionality ==		== Functionality ==

@@ Line 6: / Line 6: @@
 === Modes ===
-<code>bar2vtk</code> has two primary modes; cli (short for ''command line interface'') and toml. They are both equally capable. The cli operates solely on the command line via standard flag and argument system. The toml system uses configuration files (in a [https://toml.io/en/ toml] format) to control the program instead.
+<code>bar2vtk</code> has two primary modes; cli (short for ''command line interface'') and toml. They have equal capabilities. The cli operates solely on the command line via standard flag and argument system. The toml system uses configuration files (in a [https://toml.io/en/ toml] format) to control the program instead.
-To access the cli or toml modes, simply append the either cli or toml to the command:
+Below is a equivalency table for cli flags/arguments vs toml config declarations. A more detailed description for each option is given in [[Bar2vtk#Options|Options]].
 {| class="wikitable"
@@ Line 88: / Line 83: @@
 blankvtmfile = 'vtkFiles/example_blank.vtm'
 debug = false
-new_file_prefix = 'CRS_4delta_12-30_basestab'
+new_file_prefix = ''
 outpath = ''
 stsbar = []

← Older revision	Revision as of 17:57, 18 September 2022
(No difference)

@@ Line 13: / Line 13: @@
      bar2vtk toml [...]
-The documentation below is given for the cli interface.
+Below is a equivalency table for cli vs toml options. A more detailed description for each option is given in [[Bar2vtk#Options|Options]].
 {| class="wikitable"

@@ Line 75: / Line 75: @@
 '''Example:'''
-* Searches for <code>{vel,sts}bar*.10000*</code> in <code>./data</code>
+{| class="wikitable"
 * Outputs <code>example_blank_10000.vtm</code> to the <code>vtkFiles/</code> directory
 === *bar File Searching ===
-When searching for the *bar file(s) in <code>barfiledir</code>, <code>bar2vtk</code> uses a glob of <code>{vel,sts}bar*.{timestep}*</code> to find them. If the glob matches more than one file, it will return an error.
+When searching for the *bar file(s) in <code>barfiledir</code>, <code>bar2vtk</code> uses a regex of <code>^{vel,sts}bar.*{timestep}(?![\d|-]).*</code> to find them. For example, given <code>timestep=200</code>, this regex string will return the files <code>velbar.200</code> or <code>velbar.200.1</code>, but not <code>velbar.2000</code> or <code>velbar.200-300.1</code>. If the regex matches more than one file, it will return an error.
 If setting the *bar file paths explicitly using [[Bar2vtk#--velbar_and_--stsbar|<code>--velbar</code> and <code>--stsbar</code>]], <code>barfiledir</code> will be ignored and no globing will occur.
@@ Line 89: / Line 112: @@
 '''Example:'''
-  bar2vtk cli vtkFiles/example_blank.vtm data/ 10000-20000 --ts0 5000
+{| class="wikitable"
-* Searches for <code>{vel,sts}bar*.10000*</code> and <code>{vel,sts}bar*.20000*</code> in <code>./data</code>
+~> bar2vtk toml input.toml
 * Outputs <code>example_blank_10000-20000.vtm</code> to the <code>vtkFiles/</code> directory
@@ Line 152: / Line 197: @@
 ts0 = 0
 velbar = []
-velonly = false
+velonly = false </nowiki>
-</nowiki>
 [[Category:VTKpytools]]

@@ Line 128: / Line 128: @@
   bar2vtk example_blank.vtm data/ 10000 -f otherprefix
       # output file name is "otherprefix_10000.vtm"
 [[Category:VTKpytools]]

@@ Line 50: / Line 50: @@
 |-
 | <code>--velonly</code>
-| <code>--velonly= [true/false]</code>
+| <code>velonly = [true/false]</code>
 | Whether to only include data from <code>velbar</code> files
 |-