Skip to content

Commit 163ab61

Browse files
Releasing 0.0.3. Updated docstrings and fixed minor bug
1 parent a585fc9 commit 163ab61

File tree

2 files changed

+22
-20
lines changed

2 files changed

+22
-20
lines changed

README.md

+21-19
Original file line numberDiff line numberDiff line change
@@ -38,37 +38,39 @@ Additionally, if you use VSCode, I highly recomment installing the [H5Web extens
3838

3939
**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.
4040

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`:
4244
```
4345
(mdsh5)% python mdsh5/read_mds.py -h
44-
usage: read_mds.py [-h] [-n SHOT_NUMBERS [SHOT_NUMBERS ...]] [-t TREES [TREES ...]] [-p POINT_NAMES [POINT_NAMES ...]] [-s SERVER] [-r RESAMPLE [RESAMPLE ...]]
45-
[--rescale RESCALE [RESCALE ...]] [-o OUT_FILENAME] [--reread_data] [-v] [-c CONFIG]
46+
usage: read_mds.py [-h] [-n SHOT_NUMBERS [SHOT_NUMBERS ...]] [-t TREES [TREES ...]] [-p POINT_NAMES [POINT_NAMES ...]] [-s SERVER] [-r RESAMPLE [RESAMPLE ...]] [--rescale RESCALE [RESCALE ...]] [-o OUT_FILENAME]
47+
[--reread_data] [-v] [-c CONFIG] [--configTemplate]
4648
47-
Read MDSplus channel
49+
Read data from MDSPlus server for porivded shot numbers, trees, and pointnames.
4850
4951
options:
5052
-h, --help show this help message and exit
51-
-n, --shot_numbers SHOT_NUMBERS [SHOT_NUMBERS ...]
53+
-n SHOT_NUMBERS [SHOT_NUMBERS ...], --shot_numbers SHOT_NUMBERS [SHOT_NUMBERS ...]
5254
Shot number(s)
53-
-t, --trees TREES [TREES ...]
55+
-t TREES [TREES ...], --trees TREES [TREES ...]
5456
Tree name(s)
55-
-p, --point_names POINT_NAMES [POINT_NAMES ...]
56-
Point name(s)
57-
-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
60-
beginning.Example: --resample " -0.1" 10.0 0.1
57+
-p POINT_NAMES [POINT_NAMES ...], --point_names POINT_NAMES [POINT_NAMES ...]
58+
Point name(s). Must match number of trees provided unless a single tree is given.
59+
-s SERVER, --server SERVER
60+
Server address. Default is None
61+
-r RESAMPLE [RESAMPLE ...], --resample RESAMPLE [RESAMPLE ...]
62+
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
6164
--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
6568
Output filename for saving data in file. Default is None. in which case it does not save files.
6669
--reread_data Will overwrite on existing data for corresponding data entries in out_file. Default behavior is to skip readingpointnames whose data is present.
6770
-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.
7274
```
7375
Note that you can get configuration templates by using --configTemplate option and learn more by reading those files.
7476

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[project]
22
name = "mdsh5"
33
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."
4-
version = "0.0.2"
4+
version = "0.0.3"
55
license = {file = "LICENSE"}
66
readme = "README.md"
77
authors = [

0 commit comments

Comments
 (0)