rda-python-dsarch 2.0.11__tar.gz → 2.0.13__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (22) hide show
  1. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/PKG-INFO +4 -2
  2. rda_python_dsarch-2.0.13/README.md +5 -0
  3. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/pyproject.toml +1 -1
  4. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch/dsarch.usg +75 -70
  5. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch.egg-info/PKG-INFO +4 -2
  6. rda_python_dsarch-2.0.11/README.md +0 -3
  7. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/LICENSE +0 -0
  8. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/MANIFEST.in +0 -0
  9. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/setup.cfg +0 -0
  10. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch/PgArch.py +0 -0
  11. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch/PgMeta.py +0 -0
  12. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch/__init__.py +0 -0
  13. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch/ds_arch.py +0 -0
  14. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch/dsarch.py +0 -0
  15. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch/pg_arch.py +0 -0
  16. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch/pg_meta.py +0 -0
  17. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch.egg-info/SOURCES.txt +0 -0
  18. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch.egg-info/dependency_links.txt +0 -0
  19. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch.egg-info/entry_points.txt +0 -0
  20. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch.egg-info/requires.txt +0 -0
  21. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/src/rda_python_dsarch.egg-info/top_level.txt +0 -0
  22. {rda_python_dsarch-2.0.11 → rda_python_dsarch-2.0.13}/tests/test_dsarch.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: rda_python_dsarch
3
- Version: 2.0.11
3
+ Version: 2.0.13
4
4
  Summary: RDA Python package for utility program dsarch archive RDA data
5
5
  Author-email: Zaihua Ji <zji@ucar.edu>
6
6
  Project-URL: Homepage, https://github.com/NCAR/rda-python-dsarch
@@ -15,6 +15,8 @@ Requires-Dist: rda_python_common
15
15
  Requires-Dist: rda_python_setuid
16
16
  Dynamic: license-file
17
17
 
18
- RDA python Package to archive and maintain RDA datasets.
18
+ # dsarch
19
+
20
+ Python project to archive and maintain datasets for the [NSF NCAR Geoscience Data Exchange (GDEX)](https://gdex.ucar.edu).
19
21
 
20
22
  The user guide for this utility tool can be viewed at: [User guide](https://gdex-docs-dsarch.readthedocs.io).
@@ -0,0 +1,5 @@
1
+ # dsarch
2
+
3
+ Python project to archive and maintain datasets for the [NSF NCAR Geoscience Data Exchange (GDEX)](https://gdex.ucar.edu).
4
+
5
+ The user guide for this utility tool can be viewed at: [User guide](https://gdex-docs-dsarch.readthedocs.io).
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "rda_python_dsarch"
7
- version = "2.0.11"
7
+ version = "2.0.13"
8
8
  authors = [
9
9
  { name="Zaihua Ji", email="zji@ucar.edu" },
10
10
  ]
@@ -2,17 +2,17 @@
2
2
  1 INTRODUCTION
3
3
 
4
4
  'dsarch' is the primary tool for archiving geoscience data onto CISL's Geoscience
5
- Data Exchange (GDEX) Servers. It records metadata about each dataset — file names,
5
+ Data Exchange (GDEX) Servers. It records metadata for each dataset — file names,
6
6
  data periods, file counts, and sizes — in the Geoscience Data Exchange Database
7
- (GDEXDB). Datasets can be placed under DOI/Version control by assigning a Digital
8
- Object Identifier (DOI), which links all web data files to a specific version for
9
- citation and long-term reference. Archived files can be organized into sub-products
10
- called groups, which nest to any depth. All metadata stored in GDEXDB can be
11
- retrieved and updated through 'dsarch' as well.
12
-
13
- Before using 'dsarch', a dataset must first be registered in GDEXDB through
14
- Metadata Manager (https://gdex.ucar.edu/metaman/). Once registered,
15
- 'dsarch' can perform the following major functions:
7
+ (GDEXDB). A dataset can be placed under DOI/Version control by assigning a
8
+ Digital Object Identifier (DOI), linking all web data files to a specific
9
+ version for citation and long-term reference. Files can be organized into nested
10
+ sub-products called groups. All metadata stored in GDEXDB can also be retrieved
11
+ and updated through 'dsarch'.
12
+
13
+ Before using 'dsarch', register the dataset in GDEXDB through Metadata Manager
14
+ (https://gdex.ucar.edu/metaman/). Once registered, 'dsarch' can perform the
15
+ following major functions:
16
16
  - Set up a dataset and its groups/subgroups in GDEXDB to prepare it for
17
17
  data archiving
18
18
  - Add, update, and terminate DOI/Version controls for a given dataset
@@ -51,14 +51,14 @@ and upload them as tar files to the Quasar server.
51
51
  'dsarch' includes safeguards to prevent accidental operations on the wrong
52
52
  dataset. Input files must be named starting with the dataset number in the
53
53
  format 'dNNNNNN.*', where '*' matches one or more valid filename characters.
54
- 'dsarch' also checks that the specialist running it is an authorized owner of
54
+ 'dsarch' also verifies that the specialist running it is an authorized owner of
55
55
  the dataset; if not, execution stops — unless Mode option -MD (-MyDataset) is
56
56
  supplied, which overrides the ownership check.
57
57
 
58
- If an archive action (-AW, -AS, -AH, -AQ) fails because of a storage system
59
- outage, 'dsarch' will automatically retry it once the system recovers. This
60
- retry behavior is only enabled when option -BP (-d) is used to submit the
61
- action as a background batch process; the retry state is tracked in GDEXDB.
58
+ If an archive action (-AW, -AS, -AH, -AQ) fails due to a storage system outage,
59
+ 'dsarch' automatically retries it once the system recovers. Retry behavior is
60
+ enabled only when option -BP (-d) is used to submit the action as a background
61
+ batch process; the retry state is tracked in GDEXDB.
62
62
 
63
63
  Once added, a DOI/Version control record cannot be removed, but it can be
64
64
  terminated when a dataset is retired and its data are no longer current. Even
@@ -84,7 +84,7 @@ Examples are provided throughout each section.
84
84
 
85
85
  Brackets [] indicate optional elements. A pipe '|' within parentheses, as in
86
86
  (A|B), means either A or B may be used. Options fall into three categories:
87
- Action options - specify what task to execute
87
+ Action options - specify the task to execute
88
88
  Mode options - modify how an action behaves
89
89
  Info options - supply values to the action
90
90
 
@@ -127,10 +127,12 @@ The description of an individual option is shown when 'dsarch' is run as
127
127
 
128
128
  The description is shown for the option placed either before or after -(h|help).
129
129
  If no option is given, or 'dsarch' is run without arguments, the full document
130
- is displayed using the UNIX 'more' utility.
130
+ is displayed using the UNIX 'more' utility. A hard copy of this document
131
+ can be printed from the saved file, dsarch.usg, in the rda_python_dsarch
132
+ Python package.
131
133
 
132
134
  #The online version of this document is available at
133
- #https://gdex-docs-dsarch.readthedocs.io/en/latest/index.html
135
+ #https://gdex-docs-dsarch.readthedocs.io
134
136
 
135
137
 
136
138
  3 ACTION OPTIONS
@@ -196,7 +198,7 @@ Actions are grouped into seven categories based on the information they handle:
196
198
  [-(ED|EndDate) EndOnDates]
197
199
  [-(ET|EndTime) EndOnTimes]
198
200
 
199
- Mode options that can be specified for this action:
201
+ Available mode options:
200
202
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
201
203
  regardless of dataset ownership
202
204
  -(NT|NoTrim) - skips trimming of spaces and comments from input
@@ -208,7 +210,7 @@ Actions are grouped into seven categories based on the information they handle:
208
210
 
209
211
  Dataset numbers are normally created via the Metadata Manager (MM). Action
210
212
  -SD modifies the dataset record and any associated group data periods.
211
- Data periods for groups can be modified by 'dsarch', but must be created
213
+ Data periods for groups can be modified in 'dsarch', but must be created
212
214
  or removed through MM.
213
215
 
214
216
  The web file access location flag is set via -LC (-Location). The default
@@ -231,7 +233,7 @@ Actions are grouped into seven categories based on the information they handle:
231
233
  [-(OF|OutputFile) OutputFileName]
232
234
  [-(DB|Debug) DebugModeInfo]
233
235
 
234
- Mode options that can be specified for this action:
236
+ Available mode options:
235
237
  -(FO|FormatOutput) - formats each column to a uniform fixed width
236
238
  -(PE|ShowPeriod) - includes associated period information for the dataset
237
239
  and any groups
@@ -315,7 +317,7 @@ GroupIndex<:>BeginDate<:>EndDate<:>BeginTime<:>EndTime<:>
315
317
  [-(ET|EndTime) VersionEndTime]
316
318
  [-(DE|Description) VersionNote]
317
319
 
318
- Mode options that can be specified for this action:
320
+ Available mode options:
319
321
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
320
322
  regardless of dataset ownership
321
323
  -(NT|NoTrim) - skips trimming of spaces and comments from input
@@ -323,7 +325,7 @@ GroupIndex<:>BeginDate<:>EndDate<:>BeginTime<:>EndTime<:>
323
325
  -(NV|NewVersion) - adds a new version control record to GDEXDB
324
326
 
325
327
  If a version index is provided and already exists in GDEXDB, the record is
326
- modified. A new record is created when no index is given (or it is 0) and Mode
328
+ updated. A new record is created when no index is given (or it is 0) and Mode
327
329
  option -NV (-NewVersion) is present.
328
330
 
329
331
  A newly created record with no DOI number is in Pending status and can only
@@ -334,8 +336,8 @@ GroupIndex<:>BeginDate<:>EndDate<:>BeginTime<:>EndTime<:>
334
336
 
335
337
  dsarch d999009 SV -NV -DN DOINumber
336
338
 
337
- If the data of d999009 are substantially updated to a new version, run the
338
- same command with a new DOI number. The previous active record is automatically
339
+ If d999009's data are substantially updated to a new version, run the same
340
+ command with a new DOI number. The previous active record is automatically
339
341
  moved to History status and its DOI is superseded. Only one active version
340
342
  control record may exist per dataset.
341
343
 
@@ -348,8 +350,8 @@ GroupIndex<:>BeginDate<:>EndDate<:>BeginTime<:>EndTime<:>
348
350
  automatically set to 'V' for Version-controlled). Optionally create a new
349
351
  internal version at this point, then archive the replacement Web files.
350
352
 
351
- Note: Various GDEX use cases are outlined above. Review them so that DOIs in
352
- the GDEX are handled consistently.
353
+ Note: Review the use cases above to ensure DOIs in GDEX are handled
354
+ consistently.
353
355
 
354
356
  3.2.2 Get Version Control
355
357
  -GV or -GetVersion, retrieves DOI/Version control records from GDEXDB for a
@@ -361,7 +363,7 @@ GroupIndex<:>BeginDate<:>EndDate<:>BeginTime<:>EndTime<:>
361
363
  [-(OF|OutputFile) OutputFileName]
362
364
  [-(DB|Debug) DebugModeInfo]
363
365
 
364
- Mode option that can be specified for this action:
366
+ Available mode option:
365
367
  -(FO|FormatOutput) - formats each column to a uniform fixed width
366
368
 
367
369
  Use -FN (-FieldNames) to specify which version control fields to retrieve.
@@ -403,17 +405,17 @@ VersionIndex<:>InternalVersion<:>ExternalVersion<:>DOINumber<:>VersionStatus<:>B
403
405
  [-(LN|LoginName) LoginAccountName]
404
406
  [-(DB|Debug) DebugModeInfo]
405
407
 
406
- Mode options that can be specified for this action:
408
+ Available mode options:
407
409
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
408
410
  regardless of dataset ownership
409
411
  -(NT|NoTrim) - skips trimming of spaces and comments from input
410
412
  values, speeding up input file processing
411
413
 
412
414
  Provide the version index via -VI and the dataset number via -DS. Termination
413
- is blocked if any Web files are still linked to that version. To work around
414
- this, first list those files using -GW (-GetWebFile), then either reassign
415
- their version index (to 0 or another value) or convert them to Saved files;
416
- only then can the version be terminated.
415
+ is blocked if any Web files are still linked to that version. To resolve this,
416
+ first list those files using -GW (-GetWebFile), then either reassign their
417
+ version index (to 0 or another value) or convert them to Saved files; only
418
+ then can the version be terminated.
417
419
 
418
420
  For example, to terminate version index 5 of d999009:
419
421
 
@@ -453,7 +455,7 @@ VersionIndex<:>InternalVersion<:>ExternalVersion<:>DOINumber<:>VersionStatus<:>B
453
455
  [-(LN|LoginName) LoginAccountName]
454
456
  [-(DB|Debug) DebugModeInfo]
455
457
 
456
- Mode options that can be specified for this action:
458
+ Available mode options:
457
459
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
458
460
  regardless of dataset ownership
459
461
  -(NT|NoTrim) - skips trimming of spaces and comments from input
@@ -507,7 +509,7 @@ QSCAT observations.<:>
507
509
  [-(OF|OutputFile) OutputFileName]
508
510
  [-(DB|Debug) DebugModeInfo]
509
511
 
510
- Mode options that can be specified for this action:
512
+ Available mode options:
511
513
  -(FO|FormatOutput) - formats each column to a uniform fixed width
512
514
  -(RG|RecursiveGroup) - gathers subgroups recursively for a given group index
513
515
  -(WN|WithFileNumber) - gathers and displays file counts for groups
@@ -559,7 +561,7 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
559
561
  [-(LN|LoginName) LoginAccountName]
560
562
  [-(DB|Debug) DebugModeInfo]
561
563
 
562
- Mode options that can be specified for this action:
564
+ Available mode options:
563
565
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
564
566
  regardless of dataset ownership
565
567
  -(NT|NoTrim) - skips trimming of spaces and comments from input
@@ -591,7 +593,7 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
591
593
  [-(LN|LoginName) LoginAccountName]
592
594
  [-(DB|Debug) DebugModeInfo]
593
595
 
594
- Mode options that can be specified for this action:
596
+ Available mode options:
595
597
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
596
598
  regardless of dataset ownership
597
599
  -(NT|NoTrim) - skips trimming of spaces and comments from input
@@ -667,7 +669,7 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
667
669
  [-(BP|BatchProcess) [BatchControlInfo]]
668
670
  [-(DB|Debug) DebugModeInfo]
669
671
 
670
- Mode options that can be specified for this action:
672
+ Available mode options:
671
673
  -(BG|BackGround) - runs in background; suppresses screen output and errors
672
674
  -(EM|EMailNotice) - sends an email summary (including any errors) when the
673
675
  action completes or aborts
@@ -714,7 +716,7 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
714
716
  [-(OF|OutputFile) OutputFileName]
715
717
  [-(DB|Debug) DebugModeInfo]
716
718
 
717
- Mode options that can be specified for this action:
719
+ Available mode options:
718
720
  -(FO|FormatOutput) - formats each column to a uniform fixed width
719
721
  -(RG|RecursiveGroup) - gathers files in subgroups recursively for a given
720
722
  group index
@@ -788,7 +790,7 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
788
790
  [-(BP|BatchProcess) [BatchControlInfo]]
789
791
  [-(DB|Debug) DebugModeInfo]
790
792
 
791
- Mode options that can be specified for this action:
793
+ Available mode options:
792
794
  -(BG|BackGround) - runs in background; suppresses screen output and errors
793
795
  -(DX|DeleteXML) - calls 'dcm' to delete content metadata for the specified
794
796
  Web files
@@ -843,7 +845,7 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
843
845
  [-(OF|OutputFile) OutputFileName]
844
846
  [-(DB|Debug) DebugModeInfo]
845
847
 
846
- Mode options that can be specified for this action:
848
+ Available mode options:
847
849
  -(FO|FormatOutput) - formats each column to a uniform fixed width
848
850
  -(RG|RecursiveGroup) - gathers files in subgroups recursively for a given
849
851
  group index
@@ -927,7 +929,7 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
927
929
  [-(LN|LoginName) LoginAccountName]
928
930
  [-(DB|Debug) DebugModeInfo]
929
931
 
930
- Mode options that can be specified for this action:
932
+ Available mode options:
931
933
  -(BG|BackGround) - runs in background; suppresses screen output and errors
932
934
  -(EM|EMailNotice) - sends an email summary (including any errors) when the
933
935
  action completes or aborts
@@ -947,7 +949,8 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
947
949
  shared value, such as -AF, -DF, and -HT (-HelpFileType).
948
950
 
949
951
  For remotely hosted Help files (e.g., on GitHub), provide the full URL via
950
- -WU (-WebURL) to add a record without a local copy on the GDEX Server.
952
+ -WU (-WebURL) to register the file in GDEXDB without a local copy on the
953
+ GDEX Server.
951
954
 
952
955
 
953
956
  3.4.6 Get Help File Information
@@ -969,7 +972,7 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
969
972
  [-(OF|OutputFile) OutputFileName]
970
973
  [-(DB|Debug) DebugModeInfo]
971
974
 
972
- Mode option that can be specified for this action:
975
+ Available mode option:
973
976
  -(FO|FormatOutput) - formats each column to a uniform fixed width
974
977
 
975
978
  Use -FN (-FieldNames) to specify which Help file fields to retrieve. Defaults
@@ -1025,7 +1028,7 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1025
1028
  [-(BP|BatchProcess) [BatchControlInfo]]
1026
1029
  [-(DB|Debug) DebugModeInfo]
1027
1030
 
1028
- Mode options that can be specified for this action:
1031
+ Available mode options:
1029
1032
  -(BG|BackGround) - runs in background; suppresses screen output and errors
1030
1033
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
1031
1034
  regardless of dataset ownership
@@ -1059,7 +1062,7 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1059
1062
  [-(OF|OutputFile) OutputFileName]
1060
1063
  [-(DB|Debug) DebugModeInfo]
1061
1064
 
1062
- Mode option that can be specified for this action:
1065
+ Available mode option:
1063
1066
  -(FO|FormatOutput) - formats each column to a uniform fixed width
1064
1067
 
1065
1068
  Use -FN (-FieldNames) to specify which Quasar file fields to retrieve. Defaults
@@ -1122,7 +1125,7 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1122
1125
  [-(DD|DeleteDir) DeleteLocalDirLevel]
1123
1126
  [-(DB|Debug) DebugModeInfo]
1124
1127
 
1125
- Mode options that can be specified for this action:
1128
+ Available mode options:
1126
1129
  -(BG|BackGround) - runs in background; suppresses screen output and errors
1127
1130
  -(CL|CleanLocal) - removes local files after all are successfully archived
1128
1131
  -(EM|EMailNotice) - sends an email summary (including any errors) when the
@@ -1207,7 +1210,7 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1207
1210
  [-(DD|DeleteDir) DeleteLocalDirLevel]
1208
1211
  [-(DB|Debug) DebugModeInfo]
1209
1212
 
1210
- Mode options that can be specified for this action:
1213
+ Available mode options:
1211
1214
  -(BG|BackGround) - runs in background; suppresses screen output and errors
1212
1215
  -(CL|CleanLocal) - removes local files after all are successfully archived
1213
1216
  -(EM|EMailNotice) - sends an email summary (including any errors) when the
@@ -1290,7 +1293,7 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1290
1293
  [-(DD|DeleteDir) DeleteLocalDirLevel]
1291
1294
  [-(DB|Debug) DebugModeInfo]
1292
1295
 
1293
- Mode options that can be specified for this action:
1296
+ Available mode options:
1294
1297
  -(BG|BackGround) - runs in background; suppresses screen output and errors
1295
1298
  -(CL|CleanLocal) - removes local files after all are successfully archived
1296
1299
  -(EM|EMailNotice) - sends an email summary (including any errors) when the
@@ -1343,7 +1346,7 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1343
1346
  [-(BP|BatchProcess) [BatchControlInfo]]
1344
1347
  [-(DB|Debug) DebugModeInfo]
1345
1348
 
1346
- Mode options that can be specified for this action:
1349
+ Available mode options:
1347
1350
  -(BG|BackGround) - runs in background; suppresses screen output and errors
1348
1351
  -(EM|EMailNotice) - sends an email summary (including any errors) when the
1349
1352
  action completes or aborts
@@ -1364,9 +1367,9 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1364
1367
 
1365
1368
  3.4.13 Restore Quasar Files
1366
1369
  -RQ or -RestoreQuasarFile (Alias: -RestoreQuasar|-RestoreBackupFile|-RestoreBackup),
1367
- finds the Quasar tar files that contain the specified Saved and/or Web files,
1368
- downloads them from the Globus Quasar Server, and restores any files that
1369
- are missing from the GDEX Server.
1370
+ finds the Quasar tar files containing the specified Saved and/or Web files,
1371
+ downloads them from the Globus Quasar Server, and restores any files missing
1372
+ from the GDEX Server.
1370
1373
 
1371
1374
  dsarch [-(DS|dataset)] dNNNNNN -(RQ|RestoreQuasarFile) [Mode Options]
1372
1375
  [-(QF|QuasarFile) QuasarFileNames]
@@ -1379,7 +1382,7 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1379
1382
  [-(BP|BatchProcess) [BatchControlInfo]]
1380
1383
  [-(DB|Debug) DebugModeInfo]
1381
1384
 
1382
- Mode options that can be specified for this action:
1385
+ Available mode options:
1383
1386
  -(BG|BackGround) - runs in background; suppresses screen output and errors
1384
1387
  -(EM|EMailNotice) - sends an email summary (including any errors) when the
1385
1388
  action completes or aborts
@@ -1398,8 +1401,8 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1398
1401
  -MV or -MoveFile, relocates archived files — across datasets, between groups,
1399
1402
  or to a new name. One or more files may be moved per execution.
1400
1403
 
1401
- When a file's name or path changes, 'dsarch' keeps the original name in GDEXDB
1402
- as a linked alias pointing to the new name.
1404
+ When a file's name or path changes, 'dsarch' retains the original name in
1405
+ GDEXDB as a linked alias pointing to the new name.
1403
1406
 
1404
1407
  Files can also be converted between types (Web to Saved or Saved to Web)
1405
1408
  using -TS (-ToSaved) or -TW (-ToWeb).
@@ -1471,7 +1474,7 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1471
1474
  [-(LN|LoginName) LoginAccountName]
1472
1475
  [-(DB|Debug) DebugModeInfo]
1473
1476
 
1474
- Mode options that can be specified for this action:
1477
+ Available mode options:
1475
1478
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
1476
1479
  regardless of dataset ownership
1477
1480
  -(NT|NoTrim) - skips trimming of spaces and comments from input
@@ -1534,7 +1537,7 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1534
1537
  [-(LN|LoginName) LoginAccountName]
1535
1538
  [-(DB|Debug) DebugModeInfo]
1536
1539
 
1537
- Mode options that can be specified for this action:
1540
+ Available mode options:
1538
1541
  -(DX|DeleteXML) - calls 'dcm' to delete content metadata for the Web files
1539
1542
  being deleted
1540
1543
  -(EM|EMailNotice) - sends an email summary (including any errors) when the
@@ -1582,9 +1585,9 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1582
1585
  Saved/Web/Help/Quasar file records for a dataset in one step. Equivalent to
1583
1586
  running -SD, -SG, -SS, -SW, -SH, and -SQ together.
1584
1587
 
1585
- dsarch -(SA|SetAll) [Mode Options]
1586
- [-(LN|LoginName) LoginAccountName]
1588
+ dsarch [-(DS|Dataset)] dNNNNNN -(SA|SetAll) [Mode Options]
1587
1589
  -(IF|InputFile) Input Files
1590
+ [-(LN|LoginName) LoginAccountName]
1588
1591
  [-(DB|Debug) DebugModeInfo]
1589
1592
 
1590
1593
  All Mode options applicable to the individual Set actions may be used with
@@ -1604,7 +1607,7 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1604
1607
 
1605
1608
  3.6.1 Regenerate Dataset Webpages
1606
1609
  -UW or -UpdateWeb, rebuilds the main and filelist webpages for the specified
1607
- dataset so they reflect the current state of GDEXDB.
1610
+ dataset to reflect the current state of GDEXDB.
1608
1611
 
1609
1612
  dsarch [-(DS|Dataset)] dNNNNNN -(UW|UpdateWeb)
1610
1613
  [-(DB|Debug) DebugModeInfo]
@@ -1830,7 +1833,8 @@ They come in two forms:
1830
1833
  ascending; lowercase means descending. When file records are modified via
1831
1834
  -AS, -AW, -SS, -SW, -DL, or -MV, files in affected groups are reordered too.
1832
1835
 
1833
- To reorder an existing file list without other changes, use -SW with -ON:
1836
+ For example, to reorder an existing file list without other changes,
1837
+ use -SW with -ON:
1834
1838
 
1835
1839
  dsarch dNNNNNN -SW -ON OrderNameString [-GI GroupIndices]
1836
1840
 
@@ -1853,6 +1857,7 @@ They come in two forms:
1853
1857
  'I' - enabled for internal users only
1854
1858
  'P' - enabled and file lists are published publicly
1855
1859
  'W' - file list publication only
1860
+
1856
1861
  Any value except 'N' must be set before 'dsarch' can write to GDEXDB.
1857
1862
 
1858
1863
  -VS or -ValidSize, the minimum acceptable file size (in bytes) for
@@ -1877,8 +1882,9 @@ They come in two forms:
1877
1882
  'Z' - compressed
1878
1883
  'GZ' - gzipped
1879
1884
  'BZ2' - bzip2-compressed
1885
+
1880
1886
  Combine values in processing order, e.g., 'C1.TAR.GZ' = COS ASCII blocked,
1881
- then tarred, then gzipped. Maximum total length is 10 characters.
1887
+ then tarred, then gzipped. Maximum total length is 20 characters.
1882
1888
 
1883
1889
  -BD or -BeginDate, the earliest date covered by the data, for a group,
1884
1890
  the whole dataset, or a version control record.
@@ -1896,7 +1902,7 @@ They come in two forms:
1896
1902
  or more host names may follow -BP to target or exclude specific hosts
1897
1903
  (e.g., '-d PBS' to use PBS batch hosts). An optional retry limit (1-99)
1898
1904
  can also be specified, e.g., '-d 5'; defaults to 2. Archive actions
1899
- (-AS, -AW, -AH, -AQ) retry automatically after storage system outages.
1905
+ (-AS, -AW, -AH, -AQ) retry automatically after storage system outage.
1900
1906
 
1901
1907
  -BS or -BackupStatus, the current Quasar backup state for a file:
1902
1908
  'A' - archived to Quasar (complete)
@@ -2014,15 +2020,12 @@ They come in two forms:
2014
2020
  128 characters.
2015
2021
 
2016
2022
  Set a pair:
2017
-
2018
2023
  dsarch d540000 SD -KV 'test=>test it'
2019
2024
 
2020
2025
  View a specific key:
2021
-
2022
2026
  dsarch d540000 GD -KV test
2023
2027
 
2024
2028
  View all pairs:
2025
-
2026
2029
  dsarch d540000 GD -KV all
2027
2030
 
2028
2031
  -LC or -Location (Alias: -LocationFlag), where the file resides:
@@ -2031,6 +2034,7 @@ They come in two forms:
2031
2034
  'O' - Object Store
2032
2035
  'B' - both Glade and Object Store
2033
2036
  'R' - remote URL (Help files only)
2037
+
2034
2038
  At the dataset level (as the online access location), only 'G' or 'O'
2035
2039
  are valid.
2036
2040
 
@@ -2093,7 +2097,7 @@ They come in two forms:
2093
2097
  used by default. For -SG and -SD, this value is written to GDEXDB.
2094
2098
 
2095
2099
  Keeping Saved paths accurate is important: NCAR users browse data through
2096
- 'rdals' using these paths. Each top-level group should map to one directory,
2100
+ 'gdexls' using these paths. Each top-level group should map to one directory,
2097
2101
  with one subdirectory per subgroup level, mirroring the physical layout.
2098
2102
 
2099
2103
  -SR or -Source, the person, team, or organization that contributed or
@@ -2106,6 +2110,7 @@ They come in two forms:
2106
2110
  'W' - Work (working/intermediate file)
2107
2111
  'S' - Scratch (temporary file)
2108
2112
  'V' - Version-controlled (locked under DOI)
2113
+
2109
2114
  One value applies to all files in the batch.
2110
2115
 
2111
2116
  -SZ or -Size, the file size in bytes. Measured automatically from local
@@ -2139,7 +2144,7 @@ They come in two forms:
2139
2144
  by default. For -SG and -SD, this value is written to GDEXDB.
2140
2145
 
2141
2146
  Keeping Web paths accurate is important: NCAR users browse data through
2142
- 'rdals' using these paths. Each top-level group should map to one directory,
2147
+ 'gdexls' using these paths. Each top-level group should map to one directory,
2143
2148
  with one subdirectory per subgroup level, mirroring the physical layout.
2144
2149
 
2145
2150
  -WT or -WebFileType (Alias: -WebType|-WebArchiveType), the accessibility of
@@ -2148,4 +2153,4 @@ They come in two forms:
2148
2153
 
2149
2154
  -WU or -WebURL (Alias: -URL|-WebAddress), the full URL of a Help file
2150
2155
  hosted remotely (e.g., on GitHub). Use with -SH (-SetHelpFile) to register
2151
- the file in GDEXDB without needing a local copy on the GDEX Server.
2156
+ the file in GDEXDB without a local copy on the GDEX Server.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: rda_python_dsarch
3
- Version: 2.0.11
3
+ Version: 2.0.13
4
4
  Summary: RDA Python package for utility program dsarch archive RDA data
5
5
  Author-email: Zaihua Ji <zji@ucar.edu>
6
6
  Project-URL: Homepage, https://github.com/NCAR/rda-python-dsarch
@@ -15,6 +15,8 @@ Requires-Dist: rda_python_common
15
15
  Requires-Dist: rda_python_setuid
16
16
  Dynamic: license-file
17
17
 
18
- RDA python Package to archive and maintain RDA datasets.
18
+ # dsarch
19
+
20
+ Python project to archive and maintain datasets for the [NSF NCAR Geoscience Data Exchange (GDEX)](https://gdex.ucar.edu).
19
21
 
20
22
  The user guide for this utility tool can be viewed at: [User guide](https://gdex-docs-dsarch.readthedocs.io).
@@ -1,3 +0,0 @@
1
- RDA python Package to archive and maintain RDA datasets.
2
-
3
- The user guide for this utility tool can be viewed at: [User guide](https://gdex-docs-dsarch.readthedocs.io).