Upload to huggingface

.gitignore

@@ -0,0 +1,28 @@
+# Files generated by invoking Julia with --code-coverage
+*.jl.cov
+*.jl.*.cov
+
+# Files generated by invoking Julia with --track-allocation
+*.jl.mem
+
+# System-specific files and directories generated by the BinaryProvider and BinDeps packages
+# They contain absolute paths specific to the host computer, and so should not be committed
+deps/deps.jl
+deps/build.log
+deps/downloads/
+deps/usr/
+deps/src/
+
+# Build artifacts for creating documentation generated by the Documenter package
+docs/build/
+docs/site/
+
+# File generated by Pkg, the package manager, based on a corresponding Project.toml
+# It records a fixed state of all packages used by the project. As such, it should not be
+# committed for packages, but should be committed for applications that require a static
+# environment.
+Manifest.toml
+
+# Do not commit large (and redundant) tar.gz files, instead, I upload them
+# to the `artifacts` branch
+artifacts/*.tar.gz

Project.toml

@@ -0,0 +1,14 @@
+[deps]
+Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+Inflate = "d25df0c9-e2be-5dd7-82c8-3ad0b3e990b9"
+SHA = "ea8e919c-243c-51af-8825-aaa63cd721ce"
+TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
+Tar = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
+
+[compat]
+Dates = "1"
+Inflate = "0.1"
+SHA = "0.7"
+TOML = "1.0"
+Tar = "1.10"
+julia = "1.11"

make_artifacts.jl

@@ -9,93 +9,69 @@
 # https://pkgdocs.julialang.org/v1/artifacts/
 #
 using Tar, Inflate, SHA, TOML
+using Dates: unix2datetime
 
-# let Artifacts.toml point to local tarballs, otherwise point to GitHub releases
-LOCAL = false
-# if on local machine, I assume all the 7z files are already decompressed
-DECOMPRESS_7Z = true
-
-# check if we are running in github actions
-if isnothing(get(ENV, "GITHUB_ACTIONS", nothing))
-    LOCAL = true
-    DECOMPRESS_7Z = false
-else
-    LOCAL = false
-    DECOMPRESS_7Z = true
-end
+"""
+folder: e.g. `"Si2"`
+local_url: use local file path for the url, for testing only
+"""
+function create_artifact(folder::AbstractString; local_url::Bool=false)
+    artifacts_dir = joinpath(@__DIR__, "artifacts")
+    datasets_dir = joinpath(@__DIR__, "datasets")
 
-if DECOMPRESS_7Z
-    PY_SCRIPT = joinpath(@__DIR__, "util/GitHub-ForceLargeFiles/src/reverse.py")
-    run(
-        Cmd([
-            "python",
-            PY_SCRIPT,
-            # reverse.py will delete the 7z files by default
-            "--delete_partitions",
-            # workaround for python argparse: only empty string "" -> false
-            "",
-            "--root_dir",
-            joinpath(@__DIR__, "datasets"),
-        ]),
-    )
-end
+    fullpath = joinpath(datasets_dir, folder)
+    isdir(fullpath) || return
 
-artifacts = Dict()
-
-const datasets_dir = joinpath(@__DIR__, "datasets")
-const artifacts_dir = joinpath(@__DIR__, "artifacts")
-# exclude the generator folder which contains the inputs for generating the datasets
-const tar_excludes = ["generator", ".gitignore", "README.md", "*.7z.*"]
-
-# gzip compression level, highest
-const GZIP = "-9"
-# By default, use gzip
-compress_prog = "gzip $GZIP"
-# Try to use pigz for parallel compression.
-# However, it is not available in github workflow (ubuntu-latest)
-try
-    run(`which pigz`)
-    # -k: keep original files
-    global compress_prog = "pigz $GZIP -k"
-catch
-    # pigz is not available
-end
+    mkpath(artifacts_dir)
 
-TAR_CMD = [
-    "tar",
-    "--exclude-vcs",
-    "--exclude-vcs-ignores",
-    "--use-compress-program=$compress_prog",
-]
-append!(TAR_CMD, ["--exclude=" * f for f in tar_excludes])
+    # exclude the inputs folder which contains the input files for generating the datasets
+    tar_excludes = ["inputs", ".gitignore", "README.md"]
 
-mkpath(artifacts_dir)
+    # gzip compression level, highest
+    GZIP = "-9"
+    # By default, use gzip
+    compress_prog = "gzip $GZIP"
+    # Try to use pigz for parallel compression.
+    # However, it is not available in github workflow (ubuntu-latest)
+    try
+        run(`which pigz`)
+        # -k: keep original files
+        global compress_prog = "pigz $GZIP -k"
+    catch
+        # pigz is not available
+    end
 
-for data in readdir(datasets_dir)
-    startswith(data, "_") && continue
-    fullpath = joinpath(datasets_dir, data)
-    isdir(fullpath) || continue
+    tar_cmd = [
+        Sys.isapple() ? "gtar" : "tar",
+        "--exclude-vcs",
+        "--exclude-vcs-ignores",
+        "--use-compress-program=$compress_prog",
+    ]
+    append!(tar_cmd, ["--exclude=" * f for f in tar_excludes])
 
-    tar_name = "$(data).tar.gz"
+    tar_name = "$(folder).tar.gz"
     outpath = joinpath(artifacts_dir, tar_name)
+    prev_dir = pwd()
     cd(fullpath) do
         files = readdir()
-        run(Cmd(vcat(TAR_CMD, ["-cvf", outpath], files)))
+        # check w90 prefix is the same as the folder name, otherwise
+        # `Wannier.Datasets.load_dataset(folder)` won't work
+        "$(folder).win" in files || @warn "No $folder.win file in the folder $folder?"
+
+        run(Cmd(vcat(tar_cmd, ["-cvf", outpath], files)))
     end
+    cd(prev_dir)
 
-    if LOCAL
+    if local_url
         # if you want to test locally
         url = "file://$(outpath)"
     else
-        # use github release to host the artifacts
-        # https://docs.github.com/en/repositories/releasing-projects-on-github/linking-to-releases
-        # 2GB limit per file, no limit on total size, no bandwidth limit
-        # https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases
-        url = "https://github.com/qiaojunfeng/WannierDatasets/releases/latest/download/$(tar_name)"
+        # use huggingface `artifacts` branch to host the artifacts
+        url = "https://huggingface.co/datasets/atomology/WannierDatasets/blob/artifacts/$(tar_name)"
     end
 
-    artifact_name = data
-    artifacts[artifact_name] = Dict(
+    artifact_name = folder
+    return artifact_name => Dict(
         "git-tree-sha1" => Tar.tree_hash(IOBuffer(inflate_gzip(outpath))),
         "lazy" => true,
         "download" =>
@@ -103,6 +79,80 @@ for data in readdir(datasets_dir)
     )
 end
 
-open("Artifacts.toml", "w") do io
-    TOML.print(io, artifacts)
+function git_hash(path::AbstractString; branch::AbstractString="HEAD")
+    return read(`git log -n 1 --pretty=format:"%H" $branch -- "$path"`, String)
+end
+
+function git_date(githash::AbstractString)
+    # get the date of the commit, unix timestamp
+    g = strip(read(`git show -s --format=%ct $githash`, String))
+    return unix2datetime(parse(Float64, g))
+end
+
+function list_previous_artifacts()
+    branch = "artifacts"
+    files = split(read(`git ls-tree -r --name-only $branch`, String))
+    filter!(f -> endswith(f, ".tar.gz"), files)
+    return Dict(f => git_hash(f; branch) for f in files)
+end
+
+function list_new_folders()
+    datasets_dir = joinpath(@__DIR__, "datasets")
+
+    prev_artifacts = list_previous_artifacts()
+
+    new_folders = String[]
+    for data in readdir(datasets_dir)
+        startswith(data, "_") && continue
+        startswith(data, ".") && continue
+        isdir(joinpath(datasets_dir, data)) || continue
+
+        dir_hash = git_hash(joinpath(basename(datasets_dir), data))
+        artifact_hash = get(prev_artifacts, "$(data).tar.gz", nothing)
+        # @info "dir_hash: $dir_hash, artifact_hash: $artifact_hash"
+        if !isnothing(artifact_hash)
+            # if date of dir_hash is older than artifact_hash
+            # then we do not need to update the artifact
+            (git_date(dir_hash) <= git_date(artifact_hash)) && continue
+        end
+        push!(new_folders, data)
+    end
+    return new_folders
+end
+
+function upload_artifacts(names::AbstractVector)
+    paths = map(names) do name
+        joinpath(@__DIR__, "artifacts", "$(name).tar.gz")
+    end
+    paths
+end
+
+function (@main)(args)
+    new_folders = list_new_folders()
+
+    toml_path = joinpath(@__DIR__, "Artifacts.toml")
+    if isfile(toml_path)
+        artifacts = TOML.parsefile(toml_path)
+    else
+        artifacts = Dict{String, Any}()
+    end
+
+    for folder in new_folders
+        artifact = create_artifact(folder)
+
+        # print the result as toml
+        buf = IOBuffer()
+        TOML.print(buf, Dict(artifact))
+        s = String(take!(buf))
+        @info "New artifact:\n$s"
+
+        push!(artifacts, artifact)
+        break
+    end
+
+    open(toml_path, "w") do io
+        TOML.print(io, artifacts)
+    end
+
+    upload_artifacts(new_folders)
 end