Skip to main content

PyPI version PyPI license pipeline status coverage report

The ioProc workflow manager

ioproc is a light-weight workflow manager for Python ensuring robust, scalable and reproducible data pipelines. The tool is developed at the German Aerospace Center (DLR) for and in the scientific context of energy systems analysis, however, it is widely applicable in other scientific fields.

how-to install

Setup a new Python environment and install ioProc using

pip install ioproc   

how-to configure

Configure your pipeline in the user.yaml. The workflow is defined by a list of actions. These must contain the fields project, call and data (with sub fields read_from_dmgr, and write_to_dmgr). The user may specify additional fields for each action under the optional key args.
You may get inspiration from the default actions in general.py.

You may also have a look into the snippets section where several basic ioproc functionalities are described:

default actions provided by ioProc

readExcel

This function is used to parse Excel files and storing it in the Data manager.

@action('general')
def parse_excel(dmgr, config, params):
    '''
    Parses given `excelFile` for specified `excelSheets` as dataframe object and stores it in the datamanager by the 
    key specified in `write_to_dmgr`.
    `excelHeader` can be set to `True` or `False`.
    
    The action may be specified in the user.yaml as follows:
    - action:
        project: general
        call: parse_excel
        data:
            read_from_dmgr: null
            write_to_dmgr: parsedData
        args:  
            excelFile: spreadsheet.xlsx
            excelSheet: sheet1
            excelHeader: True
    '''

    args = params['args']
    file = get_field(args, 'excelFile')
    excel_sheet = get_excel_sheet(args)
    header = get_header(get_field(args, 'excelHeader'))
    parsed_excel = pd.read_excel(io=file, sheet_name=excel_sheet, header=header)

    with dmgr.overwrite:
        dmgr[params['data']['write_to_dmgr']] = parsed_excel

checkpoint

Checkpoints save the current state and content of the data manger to disk in HDF5 format. The workflow can be resumed at any time from previously created checkpoints.

@action('general')
def checkpoint(dmgr, config, params):
    '''
    creates a checkpoint file in the current working directory with name
    Cache_TAG while TAG is supplied by the action config.

    :param tag: the tag for this checkpoint, this can never be "start"
    '''
    assert params['tag'] != 'start', 'checkpoints can not be named start'
    dmgr.toCache(params['tag'])
    mainlogger.info('set checkpoint "{}"'.format(params['tag']))

printData

This action prints all data stored in the data manager to the console. It can therefore be used for conveniently debugging a workflow.

@action('general')
def printData(dmgr, config, params):
    '''
    simple debugging printing function. Prints all data in the data manager.

    Does not have any parameters.
    '''
    for k, v in dmgr.items():
        mainlogger.info(k+' = \n'+str(v))

Metadata

Release files for ioproc 2.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ioproc 2.3.0
File Size Uploaded Provenance Actions
ioproc-2.3.0.tar.gz 1.3 MB Without provenance Details for ioproc-2.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ioproc 2.3.0
File Interpreter ABI Platform Actions
ioproc-2.3.0-py3-none-any.whl Python 3 none any Details for ioproc-2.3.0-py3-none-any.whl

Total release size: 1.4 MB

Release files / ioproc-2.3.0.tar.gz

Download URL ioproc-2.3.0.tar.gz
Size 1.3 MB
Tags Source
SHA-256 checksum
How to use checksums
07bd392d977944890dee272536d9872b419c8b7a8e1d6304ce44d6150efce9e1
BLAKE2b-256 checksum
How to use checksums
9797f28fe5d6d06d0ddd9a1add02a95721d35dd2b728d3ee43b31a47b9a62fe0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.0

Release files / ioproc-2.3.0-py3-none-any.whl

Download URL ioproc-2.3.0-py3-none-any.whl
Size 37.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cecc5ac08f7a1c6c3162e2a68b1c036f2f9e01c036aeb3669cf660aa0893dc8e
BLAKE2b-256 checksum
How to use checksums
393eb590d49b178ebd2b4308879a4ab70111e8d241839b15b89959131ae87730
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.0

Security for ioproc 2.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page