From cc605943a909d82bb3d6217d2c8604dc18310c64 Mon Sep 17 00:00:00 2001 From: antux18 Date: Fri, 19 Jul 2024 17:05:46 +0200 Subject: [PATCH] Added a comment section for artifacts configuration. Moved hints to the Nickel contract. --- artifacts_nickel/breitweiser_high.ncl | 1 + artifacts_nickel/isakov_taxonomy.ncl | 1 + artifacts_nickel/moses_high.ncl | 1 + artifacts_nickel/parasyris_approximate.ncl | 3 ++- artifacts_nickel/template.ncl | 5 +++-- artifacts_nickel/test.ncl | 1 + artifacts_nickel/wang_tgopt.ncl | 1 + artifacts_nickel/ziogas_deinsum-cpu.ncl | 1 + artifacts_nickel/ziogas_deinsum-gpu.ncl | 1 + workflow/nickel/artifact_contract.ncl | 7 +++++-- 10 files changed, 17 insertions(+), 5 deletions(-) diff --git a/artifacts_nickel/breitweiser_high.ncl b/artifacts_nickel/breitweiser_high.ncl index b8083b6..67c8ef8 100644 --- a/artifacts_nickel/breitweiser_high.ncl +++ b/artifacts_nickel/breitweiser_high.ncl @@ -3,6 +3,7 @@ let { Artifact, .. } = import "../workflow/nickel/artifact_contract.ncl" in artifact_url = "https://zenodo.org/record/7544675/files/SF2-code.tar.gz", type = "tar", doi = "10.1145/3572848.3577480", + comment = "", image_name = "bdm-publication-image-v7", dockerfile_location = "bdm-paper-examples/docker", package_managers = [ "dpkg" ], diff --git a/artifacts_nickel/isakov_taxonomy.ncl b/artifacts_nickel/isakov_taxonomy.ncl index b2e10ea..32cce73 100644 --- a/artifacts_nickel/isakov_taxonomy.ncl +++ b/artifacts_nickel/isakov_taxonomy.ncl @@ -3,6 +3,7 @@ let { Artifact, .. } = import "../workflow/nickel/artifact_contract.ncl" in artifact_url = "https://zenodo.org/record/6632461/files/SC22_artifacts_submission.zip", type = "zip", doi = "10.5555/3571885.3571906", + comment = "", image_name = "taxo:artefact", dockerfile_location = "SC22_artifacts_submission", package_managers = [ "dpkg", "pip" ], diff --git a/artifacts_nickel/moses_high.ncl b/artifacts_nickel/moses_high.ncl index 3113893..6aa3e32 100644 --- a/artifacts_nickel/moses_high.ncl +++ b/artifacts_nickel/moses_high.ncl @@ -3,6 +3,7 @@ let { Artifact, .. } = import "../workflow/nickel/artifact_contract.ncl" in artifact_url = "https://zenodo.org/record/7508499/files/wsmoses/PolygeistGPU-Docker-v0.2.1.zip", type = "zip", doi = "10.1145/3572848.3577475", + comment = "", image_name = "polygeist:artefact", dockerfile_location = "wsmoses-PolygeistGPU-Docker-ba18197/MocCUDA", package_managers = [ "dpkg", "pip" ], diff --git a/artifacts_nickel/parasyris_approximate.ncl b/artifacts_nickel/parasyris_approximate.ncl index e9b13b6..202a793 100644 --- a/artifacts_nickel/parasyris_approximate.ncl +++ b/artifacts_nickel/parasyris_approximate.ncl @@ -3,11 +3,12 @@ let { Artifact, .. } = import "../workflow/nickel/artifact_contract.ncl" in artifact_url = "https://zenodo.org/record/6926481/files/koparasy/HPAC-v0.0.0-Puppeteer.zip", type = "zip", doi = "10.5555/3571885.3571974", + comment = "The package 'cmake-3.14.0-Linux-x86_64' is not specified below, because it is installed using a Bash script included in the artifact archive itself.", image_name = "puppeteer:artefact", dockerfile_location = "koparasy-HPAC-2723bb8/approx/puppeteer/container", package_managers = [ "dpkg", "pip" ], git_packages = [], misc_packages = [ - { name = "HPAC", url = "https://github.com/koparasy/HPAC/archive/refs/heads/develop.zip" } # CMake also but not downloaded, so cannot add to list... + { name = "HPAC", url = "https://github.com/koparasy/HPAC/archive/refs/heads/develop.zip" } ], } | Artifact \ No newline at end of file diff --git a/artifacts_nickel/template.ncl b/artifacts_nickel/template.ncl index 0c8232f..7712695 100644 --- a/artifacts_nickel/template.ncl +++ b/artifacts_nickel/template.ncl @@ -1,11 +1,12 @@ let { Artifact, .. } = import "../workflow/nickel/artifact_contract.ncl" in { artifact_url = "https://example.com/artifact.zip", - type = "zip", # Possible values: zip, tar + type = "zip", doi = "...", + comment = "Template for artifact configuration.", image_name = "image:version", dockerfile_location = "path/to/docker/folder", - package_managers = [ "dpkg" ], # Possible values: dpkg, rpm, pacman, pip, conda + package_managers = [ "dpkg" ], git_packages = [ { name = "pkg1", location = "path/to/git/repo"} ], diff --git a/artifacts_nickel/test.ncl b/artifacts_nickel/test.ncl index a27483a..2df6175 100644 --- a/artifacts_nickel/test.ncl +++ b/artifacts_nickel/test.ncl @@ -3,6 +3,7 @@ let { Artifact, .. } = import "../workflow/nickel/artifact_contract.ncl" in artifact_url = "http://localhost/artifact.zip", type = "zip", doi = "...", + comment = "", image_name = "prog:latest", dockerfile_location = "./", package_managers = [ "dpkg", "pip" ], diff --git a/artifacts_nickel/wang_tgopt.ncl b/artifacts_nickel/wang_tgopt.ncl index ff1796f..8b80ed5 100644 --- a/artifacts_nickel/wang_tgopt.ncl +++ b/artifacts_nickel/wang_tgopt.ncl @@ -3,6 +3,7 @@ let { Artifact, .. } = import "../workflow/nickel/artifact_contract.ncl" in artifact_url = "https://zenodo.org/record/7328505/files/tgopt-artifact.tgz", type = "tar", doi = "10.1145/3572848.3577490", + comment = "", image_name = "tgopt:artefact", dockerfile_location = "tgopt-artifact", package_managers = [ "dpkg", "conda" ], diff --git a/artifacts_nickel/ziogas_deinsum-cpu.ncl b/artifacts_nickel/ziogas_deinsum-cpu.ncl index 8326cfb..a06a1ba 100644 --- a/artifacts_nickel/ziogas_deinsum-cpu.ncl +++ b/artifacts_nickel/ziogas_deinsum-cpu.ncl @@ -3,6 +3,7 @@ let { Artifact, .. } = import "../workflow/nickel/artifact_contract.ncl" in artifact_url = "https://zenodo.org/record/7004393/files/deinsum/sc22-artifact-0.4.zip", type = "zip", doi = "10.5555/3571885.3571918", + comment = "", image_name = "deinsum:artefact-cpu", dockerfile_location = "deinsum-sc22-artifact-7559901/docker_cpu", package_managers = [ "dpkg", "pip" ], diff --git a/artifacts_nickel/ziogas_deinsum-gpu.ncl b/artifacts_nickel/ziogas_deinsum-gpu.ncl index ec1a78f..89fcaa9 100644 --- a/artifacts_nickel/ziogas_deinsum-gpu.ncl +++ b/artifacts_nickel/ziogas_deinsum-gpu.ncl @@ -2,6 +2,7 @@ let { Artifact, .. } = import "../workflow/nickel/artifact_contract.ncl" in { artifact_url = "https://zenodo.org/record/7004393/files/deinsum/sc22-artifact-0.4.zip", type = "zip", + comment = "", doi = "10.5555/3571885.3571918", image_name = "deinsum:artefact_gpu", dockerfile_location = "deinsum-sc22-artifact-7559901/docker_gpu", diff --git a/workflow/nickel/artifact_contract.ncl b/workflow/nickel/artifact_contract.ncl index 2ca511e..2724916 100644 --- a/workflow/nickel/artifact_contract.ncl +++ b/workflow/nickel/artifact_contract.ncl @@ -44,11 +44,14 @@ in | doc "URL where to download the artifact" | URL, type - | doc "Type of the archive (zip, tar, ...)" + | doc "Type of the archive. Possible values: zip, tar" | ArchiveType, doi | doc "DOI of the artifact" | String, + comment + | doc "Additional comments on the artifact that couldn't be written elsewhere" + | String, image_name | doc "Name to give the image when building" | ImageName, @@ -56,7 +59,7 @@ in | doc "Path to the dockerfile in the artifact" | FilePath, package_managers - | doc "Package Managers used in the container" + | doc "Package Managers used in the container. Possible values: dpkg, rpm, pacman, pip, conda" | Array PackageManager, git_packages | doc "Git repositories cloned in the container"