Loading .gitlab-ci.yml +8 −8 Original line number Diff line number Diff line Loading @@ -73,19 +73,19 @@ publish-docs: when: never - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH changes: - pipe-cli/**/* - pipe-lib/**/* - pipe-py/**/* - xylem-cli/**/* - xylem-lib/**/* - xylem-py/**/* script: - make doc - git config --global user.name "${USER}" - git config --global user.email "${EMAIL}" - git clone https://user:${ACCESS_TOKEN}@code-int.ornl.gov/sites/pipe.git site - git clone https://user:${ACCESS_TOKEN}@code-int.ornl.gov/sites/xylem.git site - ls - ls site - rm -rf ./site/html - mv target/doc/ ./site/html - echo '<meta http-equiv="refresh" content="0; url=pipe_lib/index.html">' > ./site/html/index.html - echo '<meta http-equiv="refresh" content="0; url=xylem_lib/index.html">' > ./site/html/index.html - cd site - git add html - git commit -m "Publish changes" Loading @@ -111,12 +111,12 @@ publish-release: - Cargo.toml release: tag_name: "v$PKG_VERSION" description: "PIPE CLI v$PKG_VERSION" description: "Xylem v$PKG_VERSION" ref: "$CI_COMMIT_SHA" assets: links: - name: "v$PKG_VERSION" url: "${PKG_REGISTRY_URL}/x86_64-unknown-linux-gnu/v${PKG_VERSION}/pipe" url: "${PKG_REGISTRY_URL}/x86_64-unknown-linux-gnu/v${PKG_VERSION}/xylem" upload-binaries: stage: release Loading @@ -138,5 +138,5 @@ upload-binaries: script: - echo "======== UPLOAD JOB ========" - ls -la bin/ - 'curl --header "JOB-TOKEN: ${CI_JOB_TOKEN}" --upload-file bin/pipe-v${PKG_VERSION} ${PKG_REGISTRY_URL}/x86_64-unknown-linux-gnu/v${PKG_VERSION}/pipe' - 'curl --header "JOB-TOKEN: ${CI_JOB_TOKEN}" --upload-file bin/xylem-v${PKG_VERSION} ${PKG_REGISTRY_URL}/x86_64-unknown-linux-gnu/v${PKG_VERSION}/xylem' ARCHITECTURE.md +12 −12 Original line number Diff line number Diff line # Architecture > This file describes the high-level architecture and some specific design decisions of PIPE > This file describes the high-level architecture and some specific design decisions of Xylem ## Components - `pipe-cli` (CLI Application) - Depends on `pipe-lib` - `xylem-cli` (CLI Application) - Depends on `xylem-lib` - Depends on [clap](https://docs.rs/clap/latest/clap/) crate for CLI arguments - Contains code for CLI [commands](./pipe-cli/src/commands/) (e.g., `run`, `check`, etc...) and [reporters](./pipe-cli/src/reporters/) - `pipe-lib` (Rust code) - Contains code for CLI [commands](./xylem-cli/src/commands/) (e.g., `run`, `check`, etc...) and [reporters](./xylem-cli/src/reporters/) - `xylem-lib` (Rust code) - Utility functions - Code for handling user input, ingesting configuration data, running workflows, etc... - `pipe-py` (Python library) - `xylem-py` (Python library) - 🚧 Under construction - Export Rust code as Python library using [PyO3/Maturin](https://github.com/PyO3/maturin) - Export select `pipe-lib` functions as Python functions - Export select `xylem-lib` functions as Python functions ## Diagram ```mermaid graph LR a[PIPE] --> b[pipe-cli/] a --> c[pipe-lib/] a --> d[pipe-py/] a[Xylem] --> b[xylem-cli/] a --> c[xylem-lib/] a --> d[xylem-py/] b --> e[CLI application] c --> f[Rust crate] d --> g[Python</br>package] e --> h[commands] e --> i[reporters] f --> j[pipe-cli</br>utility functions] f --> j[xylem-cli</br>utility functions] g --> k[Module</br>utility functions] ``` ## Notes - Tests are written for modules in adjacent `tests.rs` files within the associated module directory - Generated documentation is published to [https://pipe.ornl.gov](https://pipe.ornl.gov) No newline at end of file - Generated documentation is published to [https://xylem.ornl.gov](https://xylem.ornl.gov) No newline at end of file CITATION.cff +2 −3 Original line number Diff line number Diff line Loading @@ -3,8 +3,7 @@ cff-version: 1.2.0 title: >- Parallel Integration and Processing Engine (PIPE) CLI Application Xylem CLI Application message: >- If you use this software, please cite it using the metadata from this file. Loading @@ -20,7 +19,7 @@ authors: email: clarkcn@ornl.gov affiliation: Oak Ridge National Laboratory orcid: 'https://orcid.org/0000-0002-4826-2152' repository-code: 'https://code.ornl.gov/GSHS/common/pipe/command' repository-code: 'https://code.ornl.gov/research-enablement/xylem' abstract: >- Command line (multi)tool for sustainable science that can be used in myriad automation contexts including the Loading CONTRIBUTING.md +4 −4 Original line number Diff line number Diff line Loading @@ -7,7 +7,7 @@ ``` - Within your container, clone the project <sup>[1](#1)</sup> with ```shell git clone git@code.ornl.gov:GSHS/common/pipe/command.git git clone git@code.ornl.gov:research-enablement/xylem.git ``` - Ensure Docker container is running, then chose one of more of the following: - Open a web browser <sup>[2](#2)</sup> and navigate to `https://localhost:1337` (password = `password`) Loading @@ -18,12 +18,12 @@ ``` - Development involves mulitple [make](./Makefile) and cargo tasks: - `cargo run` - Execute code - `cargo run -- help` - Print PIPE CLI help - `cargo run -- help` - Print Xylem CLI help - `cargo run -- check --help` - Print check command CLI help - `cargo run -- run --config /path/to/config.json --dry-run -vvv` - Run workflow dry run with logging - `make lint` - Format and lint code - `make test` - Run tests and generate code coverage - `make doc` - Generate documentation (see https://pipe.ornl.gov) - `make doc` - Generate documentation (see https://xylem.ornl.gov) - `make build` - Build release binaries - Make a git branch, push changes to it, open a merge request, resolve issues Loading Loading @@ -97,4 +97,4 @@ cargo binstall cross [5] --- > See the `TARGETS` variable in [./Makefile](https://code.ornl.gov/GSHS/common/pipe/command/-/blob/main/Makefile?ref_type=heads#L31) No newline at end of file > See the `TARGETS` variable in [./Makefile](https://code.ornl.gov/research-enablement/xylem/-/blob/main/Makefile?ref_type=heads#L31) No newline at end of file Cargo.toml +4 −4 Original line number Diff line number Diff line [workspace] members = ["pipe-cli", "pipe-lib"] members = ["xylem-cli", "xylem-lib"] resolver = "2" [workspace.package] version = "0.0.9" authors = ["Jason Wohlgemuth <wohlgemuthjh@ornl.gov>"] description = "Parallel Integration and Processing Engine" documentation = "https://pipe.ornl.gov" documentation = "https://xylem.ornl.gov" readme = "README.md" homepage = "https://pipe.ornl.gov" repository = "https://code.ornl.gov/GSHS/common/pipe/command" homepage = "https://xylem.ornl.gov" repository = "https://code.ornl.gov/research-enablement/xylem" [workspace.dependencies] clap-verbosity-flag = "2.2.0" Loading Loading
.gitlab-ci.yml +8 −8 Original line number Diff line number Diff line Loading @@ -73,19 +73,19 @@ publish-docs: when: never - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH changes: - pipe-cli/**/* - pipe-lib/**/* - pipe-py/**/* - xylem-cli/**/* - xylem-lib/**/* - xylem-py/**/* script: - make doc - git config --global user.name "${USER}" - git config --global user.email "${EMAIL}" - git clone https://user:${ACCESS_TOKEN}@code-int.ornl.gov/sites/pipe.git site - git clone https://user:${ACCESS_TOKEN}@code-int.ornl.gov/sites/xylem.git site - ls - ls site - rm -rf ./site/html - mv target/doc/ ./site/html - echo '<meta http-equiv="refresh" content="0; url=pipe_lib/index.html">' > ./site/html/index.html - echo '<meta http-equiv="refresh" content="0; url=xylem_lib/index.html">' > ./site/html/index.html - cd site - git add html - git commit -m "Publish changes" Loading @@ -111,12 +111,12 @@ publish-release: - Cargo.toml release: tag_name: "v$PKG_VERSION" description: "PIPE CLI v$PKG_VERSION" description: "Xylem v$PKG_VERSION" ref: "$CI_COMMIT_SHA" assets: links: - name: "v$PKG_VERSION" url: "${PKG_REGISTRY_URL}/x86_64-unknown-linux-gnu/v${PKG_VERSION}/pipe" url: "${PKG_REGISTRY_URL}/x86_64-unknown-linux-gnu/v${PKG_VERSION}/xylem" upload-binaries: stage: release Loading @@ -138,5 +138,5 @@ upload-binaries: script: - echo "======== UPLOAD JOB ========" - ls -la bin/ - 'curl --header "JOB-TOKEN: ${CI_JOB_TOKEN}" --upload-file bin/pipe-v${PKG_VERSION} ${PKG_REGISTRY_URL}/x86_64-unknown-linux-gnu/v${PKG_VERSION}/pipe' - 'curl --header "JOB-TOKEN: ${CI_JOB_TOKEN}" --upload-file bin/xylem-v${PKG_VERSION} ${PKG_REGISTRY_URL}/x86_64-unknown-linux-gnu/v${PKG_VERSION}/xylem'
ARCHITECTURE.md +12 −12 Original line number Diff line number Diff line # Architecture > This file describes the high-level architecture and some specific design decisions of PIPE > This file describes the high-level architecture and some specific design decisions of Xylem ## Components - `pipe-cli` (CLI Application) - Depends on `pipe-lib` - `xylem-cli` (CLI Application) - Depends on `xylem-lib` - Depends on [clap](https://docs.rs/clap/latest/clap/) crate for CLI arguments - Contains code for CLI [commands](./pipe-cli/src/commands/) (e.g., `run`, `check`, etc...) and [reporters](./pipe-cli/src/reporters/) - `pipe-lib` (Rust code) - Contains code for CLI [commands](./xylem-cli/src/commands/) (e.g., `run`, `check`, etc...) and [reporters](./xylem-cli/src/reporters/) - `xylem-lib` (Rust code) - Utility functions - Code for handling user input, ingesting configuration data, running workflows, etc... - `pipe-py` (Python library) - `xylem-py` (Python library) - 🚧 Under construction - Export Rust code as Python library using [PyO3/Maturin](https://github.com/PyO3/maturin) - Export select `pipe-lib` functions as Python functions - Export select `xylem-lib` functions as Python functions ## Diagram ```mermaid graph LR a[PIPE] --> b[pipe-cli/] a --> c[pipe-lib/] a --> d[pipe-py/] a[Xylem] --> b[xylem-cli/] a --> c[xylem-lib/] a --> d[xylem-py/] b --> e[CLI application] c --> f[Rust crate] d --> g[Python</br>package] e --> h[commands] e --> i[reporters] f --> j[pipe-cli</br>utility functions] f --> j[xylem-cli</br>utility functions] g --> k[Module</br>utility functions] ``` ## Notes - Tests are written for modules in adjacent `tests.rs` files within the associated module directory - Generated documentation is published to [https://pipe.ornl.gov](https://pipe.ornl.gov) No newline at end of file - Generated documentation is published to [https://xylem.ornl.gov](https://xylem.ornl.gov) No newline at end of file
CITATION.cff +2 −3 Original line number Diff line number Diff line Loading @@ -3,8 +3,7 @@ cff-version: 1.2.0 title: >- Parallel Integration and Processing Engine (PIPE) CLI Application Xylem CLI Application message: >- If you use this software, please cite it using the metadata from this file. Loading @@ -20,7 +19,7 @@ authors: email: clarkcn@ornl.gov affiliation: Oak Ridge National Laboratory orcid: 'https://orcid.org/0000-0002-4826-2152' repository-code: 'https://code.ornl.gov/GSHS/common/pipe/command' repository-code: 'https://code.ornl.gov/research-enablement/xylem' abstract: >- Command line (multi)tool for sustainable science that can be used in myriad automation contexts including the Loading
CONTRIBUTING.md +4 −4 Original line number Diff line number Diff line Loading @@ -7,7 +7,7 @@ ``` - Within your container, clone the project <sup>[1](#1)</sup> with ```shell git clone git@code.ornl.gov:GSHS/common/pipe/command.git git clone git@code.ornl.gov:research-enablement/xylem.git ``` - Ensure Docker container is running, then chose one of more of the following: - Open a web browser <sup>[2](#2)</sup> and navigate to `https://localhost:1337` (password = `password`) Loading @@ -18,12 +18,12 @@ ``` - Development involves mulitple [make](./Makefile) and cargo tasks: - `cargo run` - Execute code - `cargo run -- help` - Print PIPE CLI help - `cargo run -- help` - Print Xylem CLI help - `cargo run -- check --help` - Print check command CLI help - `cargo run -- run --config /path/to/config.json --dry-run -vvv` - Run workflow dry run with logging - `make lint` - Format and lint code - `make test` - Run tests and generate code coverage - `make doc` - Generate documentation (see https://pipe.ornl.gov) - `make doc` - Generate documentation (see https://xylem.ornl.gov) - `make build` - Build release binaries - Make a git branch, push changes to it, open a merge request, resolve issues Loading Loading @@ -97,4 +97,4 @@ cargo binstall cross [5] --- > See the `TARGETS` variable in [./Makefile](https://code.ornl.gov/GSHS/common/pipe/command/-/blob/main/Makefile?ref_type=heads#L31) No newline at end of file > See the `TARGETS` variable in [./Makefile](https://code.ornl.gov/research-enablement/xylem/-/blob/main/Makefile?ref_type=heads#L31) No newline at end of file
Cargo.toml +4 −4 Original line number Diff line number Diff line [workspace] members = ["pipe-cli", "pipe-lib"] members = ["xylem-cli", "xylem-lib"] resolver = "2" [workspace.package] version = "0.0.9" authors = ["Jason Wohlgemuth <wohlgemuthjh@ornl.gov>"] description = "Parallel Integration and Processing Engine" documentation = "https://pipe.ornl.gov" documentation = "https://xylem.ornl.gov" readme = "README.md" homepage = "https://pipe.ornl.gov" repository = "https://code.ornl.gov/GSHS/common/pipe/command" homepage = "https://xylem.ornl.gov" repository = "https://code.ornl.gov/research-enablement/xylem" [workspace.dependencies] clap-verbosity-flag = "2.2.0" Loading
