basic setup

.github/workflows/CI.yml

@@ -25,7 +25,6 @@ jobs:
         version:
           - '1.10'
           - '1.6'
-          - 'nightly'
         os:
           - ubuntu-latest
         arch:

CITATION.bib

@@ -1,7 +1,7 @@
 @misc{TaijaBase.jl,
 	author  = {Patrick Altmeyer},
 	title   = {TaijaBase.jl},
-	url     = {https://github.com/pat-alt/TaijaBase.jl},
+	url     = {https://github.com/JuliaTrustworthyAI/TaijaBase.jl},
 	version = {v1.0.0-DEV},
 	year    = {2024},
 	month   = {3}

Project.toml

@@ -1,13 +1,16 @@
 name = "TaijaBase"
 uuid = "10284c91-9f28-4c9a-abbf-ee43576dfff6"
 authors = ["Patrick Altmeyer"]
-version = "1.0.0-DEV"
+version = "1.0.0"
 
 [compat]
-julia = "1.6"
+Aqua = "0.8"
+Test = "1.6, 1.10"
+julia = "1.6, 1.10"
 
 [extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test"]
+test = ["Aqua", "Test"]

README.md

@@ -1,7 +1,10 @@
 # TaijaBase
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://pat-alt.github.io/TaijaBase.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://pat-alt.github.io/TaijaBase.jl/dev/)
-[![Build Status](https://github.com/pat-alt/TaijaBase.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/pat-alt/TaijaBase.jl/actions/workflows/CI.yml?query=branch%3Amain)
-[![Coverage](https://codecov.io/gh/pat-alt/TaijaBase.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/pat-alt/TaijaBase.jl)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaTrustworthyAI.github.io/TaijaBase.jl/stable/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaTrustworthyAI.github.io/TaijaBase.jl/dev/)
+[![Build Status](https://github.com/JuliaTrustworthyAI/TaijaBase.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaTrustworthyAI/TaijaBase.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Coverage](https://codecov.io/gh/JuliaTrustworthyAI/TaijaBase.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaTrustworthyAI/TaijaBase.jl)
 [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
+[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
+
+This is the base package of the Taija ecosystem that ships symbols and functionality that is relevant to all packages.

docs/make.jl

@@ -8,7 +8,7 @@ makedocs(;
     authors="Patrick Altmeyer",
     sitename="TaijaBase.jl",
     format=Documenter.HTML(;
-        canonical="https://pat-alt.github.io/TaijaBase.jl",
+        canonical="https://JuliaTrustworthyAI.github.io/TaijaBase.jl",
         edit_link="main",
         assets=String[],
     ),
@@ -18,6 +18,6 @@ makedocs(;
 )
 
 deploydocs(;
-    repo="github.com/pat-alt/TaijaBase.jl",
+    repo="github.com/JuliaTrustworthyAI/TaijaBase.jl",
     devbranch="main",
 )

docs/src/index.md

@@ -4,7 +4,7 @@ CurrentModule = TaijaBase
 
 # TaijaBase
 
-Documentation for [TaijaBase](https://github.com/pat-alt/TaijaBase.jl).
+Documentation for [TaijaBase](https://github.com/JuliaTrustworthyAI/TaijaBase.jl).
 
 ```@index
 ```

src/TaijaBase.jl

@@ -1,5 +1,7 @@
 module TaijaBase
 
-# Write your package code here.
+export AbstractParallelizer
+
+include("parallelization/base.jl")
 
 end

src/parallelization/base.jl

@@ -0,0 +1,5 @@
+"An abstract type for parallelizers."
+abstract type AbstractParallelizer end
+
+include("traits.jl")
+include("functions.jl")

src/parallelization/functions.jl

@@ -0,0 +1,25 @@
+vectorize_collection(collection::Union{Vector,SubArray}) = collection
+
+vectorize_collection(collection::Base.Iterators.Zip) = map(x -> x[1], collect(collection))
+
+function vectorize_collection(collection::Matrix)
+    return [collection]
+end
+
+"""
+    parallelize(
+        parallelizer::nothing,
+        f::Function,
+        args...;
+        kwargs...,
+    )
+
+If no `AbstractParallelizer` has been supplied, just call or broadcast the function. 
+"""
+function parallelize(
+    parallelizer::Nothing, f::Function, args...; verbose::Bool=false, kwargs...
+)
+    collection = args[1]
+    collection = vectorize_collection(collection)
+    return f.(collection, args[2:end]...; kwargs...)
+end

src/parallelization/traits.jl

@@ -0,0 +1,14 @@
+"A base type for a style of process."
+abstract type ProcessStyle end
+
+"By default all types of have this trait."
+struct NotParallel <: ProcessStyle end
+ProcessStyle(::Type) = NotParallel()
+
+"Processes that can be parallelized have this trait."
+struct IsParallel <: ProcessStyle end
+
+# Implementing trait behaviour:
+parallelizable(x::T) where {T} = parallelizable(ProcessStyle(T), x)
+parallelizable(::IsParallel, x) = true
+parallelizable(::NotParallel, x) = false

test/Manifest.toml

@@ -0,0 +1,160 @@
+# This file is machine-generated - editing it directly is not advised
+
+julia_version = "1.10.2"
+manifest_format = "2.0"
+project_hash = "0be457628dfd5d423c82c1e12d8129fa1cf18c88"
+
+[[deps.Aqua]]
+deps = ["Compat", "Pkg", "Test"]
+git-tree-sha1 = "497d933e5998358c2626f782c99a8d4b90af2dd0"
+uuid = "4c88cf16-eb10-579e-8560-4a9242c79595"
+version = "0.8.4"
+
+[[deps.ArgTools]]
+uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f"
+version = "1.1.1"
+
+[[deps.Artifacts]]
+uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
+
+[[deps.Base64]]
+uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
+
+[[deps.Compat]]
+deps = ["TOML", "UUIDs"]
+git-tree-sha1 = "c955881e3c981181362ae4088b35995446298b80"
+uuid = "34da2185-b29b-5c13-b0c7-acf172513d20"
+version = "4.14.0"
+
+    [deps.Compat.extensions]
+    CompatLinearAlgebraExt = "LinearAlgebra"
+
+    [deps.Compat.weakdeps]
+    Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+    LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+
+[[deps.Dates]]
+deps = ["Printf"]
+uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
+
+[[deps.Downloads]]
+deps = ["ArgTools", "FileWatching", "LibCURL", "NetworkOptions"]
+uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
+version = "1.6.0"
+
+[[deps.FileWatching]]
+uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"
+
+[[deps.InteractiveUtils]]
+deps = ["Markdown"]
+uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
+
+[[deps.LibCURL]]
+deps = ["LibCURL_jll", "MozillaCACerts_jll"]
+uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21"
+version = "0.6.4"
+
+[[deps.LibCURL_jll]]
+deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll", "Zlib_jll", "nghttp2_jll"]
+uuid = "deac9b47-8bc7-5906-a0fe-35ac56dc84c0"
+version = "8.4.0+0"
+
+[[deps.LibGit2]]
+deps = ["Base64", "LibGit2_jll", "NetworkOptions", "Printf", "SHA"]
+uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
+
+[[deps.LibGit2_jll]]
+deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll"]
+uuid = "e37daf67-58a4-590a-8e99-b0245dd2ffc5"
+version = "1.6.4+0"
+
+[[deps.LibSSH2_jll]]
+deps = ["Artifacts", "Libdl", "MbedTLS_jll"]
+uuid = "29816b5a-b9ab-546f-933c-edad1886dfa8"
+version = "1.11.0+1"
+
+[[deps.Libdl]]
+uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
+
+[[deps.Logging]]
+uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
+
+[[deps.Markdown]]
+deps = ["Base64"]
+uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
+
+[[deps.MbedTLS_jll]]
+deps = ["Artifacts", "Libdl"]
+uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1"
+version = "2.28.2+1"
+
+[[deps.MozillaCACerts_jll]]
+uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
+version = "2023.1.10"
+
+[[deps.NetworkOptions]]
+uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
+version = "1.2.0"
+
+[[deps.Pkg]]
+deps = ["Artifacts", "Dates", "Downloads", "FileWatching", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs", "p7zip_jll"]
+uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+version = "1.10.0"
+
+[[deps.Printf]]
+deps = ["Unicode"]
+uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+
+[[deps.REPL]]
+deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
+uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
+
+[[deps.Random]]
+deps = ["SHA"]
+uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+
+[[deps.SHA]]
+uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
+version = "0.7.0"
+
+[[deps.Serialization]]
+uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
+
+[[deps.Sockets]]
+uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
+
+[[deps.TOML]]
+deps = ["Dates"]
+uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
+version = "1.0.3"
+
+[[deps.Tar]]
+deps = ["ArgTools", "SHA"]
+uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
+version = "1.10.0"
+
+[[deps.Test]]
+deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
+uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[[deps.UUIDs]]
+deps = ["Random", "SHA"]
+uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
+
+[[deps.Unicode]]
+uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
+
+[[deps.Zlib_jll]]
+deps = ["Libdl"]
+uuid = "83775a58-1f1d-513f-b197-d71354ab007a"
+version = "1.2.13+1"
+
+[[deps.nghttp2_jll]]
+deps = ["Artifacts", "Libdl"]
+uuid = "8e850ede-7688-5339-a07c-302acd2aaf8d"
+version = "1.52.0+1"
+
+[[deps.p7zip_jll]]
+deps = ["Artifacts", "Libdl"]
+uuid = "3f19e933-33d8-53b3-aaab-bd5110c3b7a0"
+version = "17.4.0+2"

test/Project.toml

@@ -0,0 +1,6 @@
+[deps]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[compat]
+Aqua = "0.8"

test/aqua.jl

@@ -0,0 +1,8 @@
+using Aqua
+
+@testset "Aqua.jl" begin
+    # Ambiguities needs to be tested seperately until the bug in Aqua package (https://github.com/JuliaTesting/Aqua.jl/issues/77) is fixed
+    Aqua.test_ambiguities([TaijaBase]; recursive=false, broken=false)
+
+    Aqua.test_all(TaijaBase; ambiguities=false)
+end

test/runtests.jl

@@ -2,5 +2,7 @@ using TaijaBase
 using Test
 
 @testset "TaijaBase.jl" begin
-    # Write your tests here.
+
+    include("aqua.jl")
+
 end