You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+21-19
Original file line number
Diff line number
Diff line change
@@ -38,37 +38,39 @@ Additionally, if you use VSCode, I highly recomment installing the [H5Web extens
38
38
39
39
**NOTE:** All tree and pointnames will be converted to upper case regardless of how you enter them. This is a chosen convention to keep the cache consistent even if you change the case of a pointname.
40
40
41
-
Additional documentation would come soon. For now, please refer to the config_examples to get started on how to provide the input configuration. Additionally, use the help flag to print out the help message from `read_mds.py`:
41
+
Additional documentation would come soon. For now, please refer to the [config_examples](https://github.com/anchal-physics/mdsh5/tree/main/mdsh5/config_examples) to get started on how to provide the input configuration.
42
+
43
+
Additionally, use the help flag to print out the help message from `read_mds.py`:
-s, --server SERVER Server address. Default is 203.230.126.231:8005
58
-
-r, --resample RESAMPLE [RESAMPLE ...]
59
-
Resample signal(s) by providing a list of start, stop, and increment values. For negative value, enclose them withing double quotes and add a space at the
Resample signal(s) by providing a list of start, stop, and increment values. For negative value, enclose them withing double quotes and add a space at the beginning.Example: --resample " -0.1"
63
+
10.0 0.1
61
64
--rescale RESCALE [RESCALE ...]
62
-
Rescale time dimension of trees to ensure that all of are in same units. Especially important if resample is used. Provide a rescaling factor to be multiplied
63
-
by time axis for each tree provides in trees option.Example: --resample " -0.1" 10.0 0.1
64
-
-o, --out_filename OUT_FILENAME
65
+
Rescale time dimension of trees to ensure that all of are in same units. Especially important if resample is used. Provide a rescaling factor to be multiplied by time axis for each tree provides
66
+
in trees option.Example: --resample " -0.1" 10.0 0.1
67
+
-o OUT_FILENAME, --out_filename OUT_FILENAME
65
68
Output filename for saving data in file. Default is None. in which case it does not save files.
66
69
--reread_data Will overwrite on existing data for corresponding data entries in out_file. Default behavior is to skip readingpointnames whose data is present.
67
70
-v, --verbose Print verbose messages
68
-
-c, --config CONFIG Configuration file containing shot_numbers, trees, point_names, server, and other settings. If provided, corresponding command line arguments are ignored.
69
-
--configTemplate If provided, configuration templates will be copied to current directory. All
70
-
other arguments will be ignored.
71
-
71
+
-c CONFIG, --config CONFIG
72
+
Configuration file containing shot_numbers, trees, point_names, server, and other settings. If provided, corresponding command line arguments are ignored.
73
+
--configTemplate If provided, configuration templates will be copied to current directory. All other arguments will be ignored.
72
74
```
73
75
Note that you can get configuration templates by using --configTemplate option and learn more by reading those files.
Copy file name to clipboardexpand all lines: pyproject.toml
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
[project]
2
2
name = "mdsh5"
3
3
description = "A higher level python package that uses mdsthin to read MDSPlus data and store it in hdf5 formate for easy caching, viewing, distribution, and analysis."
0 commit comments