Metadata-Version: 2.1
Name: sdpchainpy
Version: 1.0b2
Summary: SDPCHAIN provenance system
Home-page: https://github.com/WayneCrawford/sdpchainpy
Author: Wayne Crawford
Author-email: crawford@ipgp.fr
Keywords: provencance,data,metadata
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: progress (>=1.5)

SDPCHAIN
===========

Seismology Data Preparation Module

Routines and classes providing a consistent interface for Python programs using
the SDPCHAIN protocol, which includes:

- Create or append to a process-steps.json file at each step
    - the process-steps file is read from the input directory and written
      to the output directory.  If both directories are the same the new step
      is appended to the existing file
- command-line arguments:
    - -d (base_dir)
    - -i (in_dir), can be relative to base directory
    - -o (out_dir), can be relative to base directory
    - optional (input_file) or (input_files), will have input directory pre-pended
    - optional -of (output_file) or -ofs (output_files), will have output dir pre-pended
    - optional -f, forces writing of output file if it already exists

- For now, these parameters must have exactly the above names in the files that
  use SDPCHAIN, so that setup_paths and ProcessStep process them correctly.
  The new ArgParser subclass should eliminate this need, but pre-populating
  the argparser with base_dir, in_dir and out_dir, as well as optionally 
  input_file or input_files, output_file or output_files, and/or -f
  
Classes
---------------------

`ProcessSteps` object to hold information for a process-steps file

Command-line Routines
---------------------

These routines perform common functions while following the
SDPCHAIN rules (process-steps file, -i, -o, -d)

`sdpstep`: run a standard command-line program 

`sdpcat`: concatenate binary files

ToDo
----
Add `sdpcode`: change net and station codes?
