update pkg name to GraphsColoring

Author: djukic14

.github/workflows/CI.yml

@@ -71,6 +71,6 @@ jobs:
         shell: julia --project=docs --color=yes {0}
         run: |
           using Documenter: DocMeta, doctest
-          using GraphColoring
-          DocMeta.setdocmeta!(GraphColoring, :DocTestSetup, :(using GraphColoring); recursive=true)
-          doctest(GraphColoring)
+          using GraphsColoring
+          DocMeta.setdocmeta!(GraphsColoring, :DocTestSetup, :(using GraphsColoring); recursive=true)
+          doctest(GraphsColoring)

Project.toml

@@ -1,4 +1,4 @@
-name = "GraphColoring"
+name = "GraphsColoring"
 uuid = "ed38bb8a-6120-4024-8d1e-8789784f251b"
 authors = ["Danijel Jukić <[email protected]> and contributors"]
 version = "0.1.0"
@@ -11,7 +11,7 @@ SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
 
 [extensions]
-GraphColoringGraphs = ["Graphs"]
+GraphsColoringGraphs = ["Graphs"]
 
 [compat]
 Aqua = "0.8"

README.md

@@ -1,4 +1,4 @@
-# GraphColoring
+# GraphsColoring
 
 <p align="center">
 <picture>
@@ -7,10 +7,10 @@
 </picture>
 </p>
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://djukic14.github.io/GraphColoring.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://djukic14.github.io/GraphColoring.jl/dev/)
-[![Build Status](https://github.com/djukic14/GraphColoring.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/djukic14/GraphColoring.jl/actions/workflows/CI.yml?query=branch%3Amain)
-[![Coverage](https://codecov.io/gh/djukic14/GraphColoring.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/djukic14/GraphColoring.jl)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://djukic14.github.io/GraphsColoring.jl/stable/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://djukic14.github.io/GraphsColoring.jl/dev/)
+[![Build Status](https://github.com/djukic14/GraphsColoring.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/djukic14/GraphsColoring.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Coverage](https://codecov.io/gh/djukic14/GraphsColoring.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/djukic14/GraphsColoring.jl)
 
 ## Introduction
 
@@ -25,5 +25,5 @@ Currently, the following aspects are implemented (✓) and planned (⌛):
 
 ## Documentation
 
-- Documentation for the [latest stable version](https://djukic14.github.io/GraphColoring.jl/stable/).
-- Documentation for the [development version](https://djukic14.github.io/GraphColoring.jl/dev/)
+- Documentation for the [latest stable version](https://djukic14.github.io/GraphsColoring.jl/stable/).
+- Documentation for the [development version](https://djukic14.github.io/GraphsColoring.jl/dev/)

docs/Project.toml

@@ -3,6 +3,6 @@ BEAST = "bb4162c7-ba94-5a20-af32-d8ec4428bdd1"
 CompScienceMeshes = "3e66a162-7b8c-5da0-b8f8-124ecd2c3ae1"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 GmshTools = "82e2f556-b1bd-5f1a-9576-f93c0da5f0ee"
-GraphColoring = "ed38bb8a-6120-4024-8d1e-8789784f251b"
+GraphsColoring = "ed38bb8a-6120-4024-8d1e-8789784f251b"
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
 PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a"

docs/make.jl

@@ -1,8 +1,8 @@
-using GraphColoring
+using GraphsColoring
 using Graphs, PlotlyJS
 using Documenter
 
-import GraphColoring:
+import GraphsColoring:
     node,
     partition,
     gather,
@@ -16,7 +16,7 @@ import GraphColoring:
 
 # this will be moved to BEAST as soon as the pull request is ready
 using BEAST
-function GraphColoring.conflicts(
+function GraphsColoring.conflicts(
     space::BEAST.Space;
     addata=BEAST.assemblydata(space),
     refspace=BEAST.refspace(space),
@@ -36,26 +36,26 @@ function GraphColoring.conflicts(
         end
     end
     return eachindex(elements),
-    GraphColoring.ConflictFunctor(conflictindices),
+    GraphsColoring.ConflictFunctor(conflictindices),
     Base.OneTo(numfunctions(space))
 end
 
-DocMeta.setdocmeta!(GraphColoring, :DocTestSetup, :(using GraphColoring); recursive=true)
+DocMeta.setdocmeta!(GraphsColoring, :DocTestSetup, :(using GraphsColoring); recursive=true)
 
 makedocs(;
     modules=[
-        GraphColoring,
+        GraphsColoring,
         if isdefined(Base, :get_extension)
-            Base.get_extension(GraphColoring, :GraphColoringGraphs)
+            Base.get_extension(GraphsColoring, :GraphsColoringGraphs)
         else
-            GraphColoring.GraphColoringGraphs
+            GraphsColoring.GraphsColoringGraphs
         end,
     ],
     authors="Danijel Jukić <[email protected]> and contributors",
-    sitename="GraphColoring.jl",
+    sitename="GraphsColoring.jl",
     format=Documenter.HTML(;
         prettyurls=true,
-        canonical="https://djukic14.github.io/GraphColoring.jl",
+        canonical="https://djukic14.github.io/GraphsColoring.jl",
         edit_link="main",
         assets=String[],
     ),
@@ -73,7 +73,7 @@ makedocs(;
 )
 
 deploydocs(;
-    repo="github.com/djukic14/GraphColoring.jl",
+    repo="github.com/djukic14/GraphsColoring.jl",
     target="build",
     devbranch="main",
     push_preview=true,

docs/src/apiref.md

@@ -4,11 +4,11 @@
 ```
 
 ```@autodocs
-Modules=[GraphColoring,
+Modules=[GraphsColoring,
         if isdefined(Base, :get_extension)
-            Base.get_extension(GraphColoring, :GraphColoringGraphs)
+            Base.get_extension(GraphsColoring, :GraphsColoringGraphs)
         else
-            GraphColoring.GraphColoringGraphs
+            GraphsColoring.GraphsColoringGraphs
         end,
         ]
 ```

docs/src/assets/logo.svg

@@ -15,7 +15,7 @@ A conflict representation must implement the following functions:
 3. [`noconflicts`](@ref): Returns a boolean indicating whether there occurs any conflict in the whole representation.
 
 It is possible to have a [`SparseMatrixCSC`](https://docs.julialang.org/en/v1/stdlib/SparseArrays/#man-csc) from [`SparseArrays`](https://github.com/JuliaSparse/SparseArrays.jl) or a [`SimpleGraph`](https://juliagraphs.org/Graphs.jl/stable/core_functions/simplegraphs/#Graphs.SimpleGraphs.SimpleGraph) from [`Graphs.jl`](https://github.com/JuliaGraphs/Graphs.jl) as a conflict representation.
-The graph conflict representation is tied to `GraphColoring` as an extension depending on  [`Graphs.jl`](https://github.com/JuliaGraphs/Graphs.jl).
+The graph conflict representation is tied to `GraphsColoring` as an extension depending on  [`Graphs.jl`](https://github.com/JuliaGraphs/Graphs.jl).
 
 The respective representation needs to support the [`conflicts`](@ref) function that returns
 
@@ -26,25 +26,25 @@ The respective representation needs to support the [`conflicts`](@ref) function
 ```@example conflicts
 using CompScienceMeshes
 using BEAST
-using GraphColoring
+using GraphsColoring
 
 m = meshsphere(1.0, 0.1)
 X = raviartthomas(m)
 
-conflicts = GraphColoring.conflicts(X)
+conflicts = GraphsColoring.conflicts(X)
 ```
 
 ## Sparse matrix as conflict representation
 
 ```@example conflictmatrix
 using CompScienceMeshes
 using BEAST
-using GraphColoring
+using GraphsColoring
 
 m = meshsphere(1.0, 0.1)
 X = raviartthomas(m)
 
-conflicts = GraphColoring.conflictmatrix(X)
+conflicts = GraphsColoring.conflictmatrix(X)
 ```
 
 ## Graph as conflict representation
@@ -53,11 +53,11 @@ conflicts = GraphColoring.conflictmatrix(X)
 using CompScienceMeshes
 using BEAST
 using Graphs
-using GraphColoring
+using GraphsColoring
 
 m = meshsphere(1.0, 0.1)
 X = raviartthomas(m)
 
-conflicts = GraphColoring.conflictgraph(X)
+conflicts = GraphsColoring.conflictgraph(X)
 println(typeof(conflicts))
 ```

docs/src/conflicts.md

@@ -15,7 +15,7 @@ For a consistent style the [JuliaFormatter.jl](https://github.com/domluna/JuliaF
 
 ```julia
 using JuliaFormatter
-format(pkgdir(GraphColoring; overwrite=true))
+format(pkgdir(GraphsColoring; overwrite=true))
 ```
 
 !!! note
@@ -35,20 +35,20 @@ Write tests for your code changes and verify that no errors occur, e.g., by runn
 
 ```julia
 using Pkg
-Pkg.test("GraphColoring")
+Pkg.test("GraphsColoring")
 ```
 
 For more detailed information on which parts are tested the coverage can be evaluated on your local machine, e.g., by
 
 ```julia
 using Pkg
-Pkg.test("GraphColoring"; coverage=true, julia_args=`--threads 6`)
+Pkg.test("GraphsColoring"; coverage=true, julia_args=`--threads 6`)
 
 # determine coverage
 using Coverage
-src_folder = pkgdir(GraphColoring) * "/src"
+src_folder = pkgdir(GraphsColoring) * "/src"
 coverage   = process_folder(src_folder)
-LCOV.writefile("path-to-folder-you-like" * "GraphColoring.lcov.info", coverage)
+LCOV.writefile("path-to-folder-you-like" * "GraphsColoring.lcov.info", coverage)
 
 clean_folder(src_folder) # delete .cov files
 
@@ -57,4 +57,4 @@ covered_lines, total_lines = get_summary(coverage)
 @info "Current coverage:\n$covered_lines of $total_lines lines ($(round(Int, covered_lines / total_lines * 100)) %)"
 ```
 
-In Visual Studio Code the [Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters) plugin can be used to visualize the tested lines of the code by inserting the path of the *GraphColoring.lcov.info* file in the settings.
+In Visual Studio Code the [Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters) plugin can be used to visualize the tested lines of the code by inserting the path of the *GraphsColoring.lcov.info* file in the settings.

docs/src/contributing.md

@@ -21,14 +21,14 @@ The colors are not guaranteed to be balanced.
 using PlotlyJS
 using CompScienceMeshes
 using BEAST
-using GraphColoring
+using GraphsColoring
 
 m = meshsphere(1.0, 0.1)
 X = raviartthomas(m)
 
-conflicts = GraphColoring.conflictmatrix(X)
+conflicts = GraphsColoring.conflictmatrix(X)
 
-colors = GraphColoring.color(conflicts; algorithm=DSATUR())
+colors = GraphsColoring.color(conflicts; algorithm=DSATUR())
 
 for (i, color) in enumerate(colors)
     println("Color $i has $(length(color)) elements")