Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve forward model transaction file behavior #13

Open
sregales-TNO opened this issue Jun 17, 2024 · 0 comments
Open

improve forward model transaction file behavior #13

sregales-TNO opened this issue Jun 17, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@sregales-TNO
Copy link
Contributor

Currently, each forward model maintained in this project takes an input file and outputs another.
However, the output is similar to the input but slightly modified by the forward model job.

This behavior litters the environment with files users neither cares for nor know about.

graph LR
    subgraph Workflow
        A[File] --> B[Forward Model A]
        B --> C[File]
        C --> D[Forward Model B]
        D --> E[File]
        E --> F[Forward Model C]
        F --> G[File]

        style A fill:#ffcc00,stroke:#333,stroke-width:2px,color:#000000
        style C fill:#ff6666,stroke:#333,stroke-width:2px
        style E fill:#66ff66,stroke:#333,stroke-width:2px
        style G fill:#6699ff,stroke:#333,stroke-width:2px
    end
Loading

The ideal behavior for transaction file

graph LR
    subgraph Workflow
        A[Transaction File] -->|read| B[Forward Model A]
        B -->|write| A
        A -->|read| D[Forward Model B]
        D -->|write| A
        A -->|read| F[Forward Model C]
        F -->|write| A

        style A fill:#ffcc00,stroke:#333,stroke-width:2px,color:#000000
    end
Loading

For backward compatibility and advanced users. specific forward model output files can still be generated.

graph LR
    subgraph Workflow
        A[Transaction File] -->|read| B[Forward Model A]
        B -->|write| A
        B -.->|Optional write| C[File A]
        A -->|read| D[Forward Model B]
        D -->|write| A
        D -.->|Optional write| E[File B]
        A -->|read| F[Forward Model C]
        F -->|write| A
        F -.->|Optional write| G[File C]

        style A fill:#ffcc00,stroke:#333,stroke-width:2px,color:#000000
        style C fill:#ff6666,stroke:#333,stroke-width:2px,fill-opacity:0.5
        style E fill:#66ff66,stroke:#333,stroke-width:2px,fill-opacity:0.5
        style G fill:#6699ff,stroke:#333,stroke-width:2px,fill-opacity:0.5
    end
Loading
@sregales-TNO sregales-TNO added the enhancement New feature or request label Jun 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

1 participant