From 7b4aaa4295d6adab4b550c4ed021cea8fdc5c623 Mon Sep 17 00:00:00 2001 From: Matt Cuffaro Date: Tue, 14 Nov 2023 08:21:42 -0500 Subject: [PATCH] hello, world! this repo will take on some functionality from decapodes --- Project.toml | 12 +++++++++--- README.md | 20 ++++++++++---------- docs/Project.toml | 2 +- docs/literate/literate_example.jl | 2 +- docs/make.jl | 16 ++++++++-------- docs/src/api.md | 2 +- docs/src/index.md | 6 +++--- src/AlgebraicTemplate.jl | 15 --------------- test/Project.toml | 2 +- test/runtests.jl | 2 +- 10 files changed, 35 insertions(+), 44 deletions(-) delete mode 100644 src/AlgebraicTemplate.jl diff --git a/Project.toml b/Project.toml index f44cb80..0195e2c 100644 --- a/Project.toml +++ b/Project.toml @@ -1,11 +1,17 @@ -name = "AlgebraicTemplate" +name = "DiagrammaticEquations.jl" uuid = "b66562e1-fa90-4e8b-9505-c909188fab76" license = "MIT" -authors = ["AlgebraicJulia Developer "] +authors = authors = [ + "James Fairbanks", + "Andrew Baas", + "Evan Patterson", + "Luke Morris", + "George Rauta", +] version = "0.0.1" [deps] -Catlab = "134e5e36-593f-5add-ad60-77f754baafbe" +Catlab = "d3509f1a-f4fe-4f63-b9c2-a8cefdb22603" [compat] Catlab = "^0.14" diff --git a/README.md b/README.md index b7d16a7..e8cbab3 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# AlgebraicTemplate.jl +# AlgebraicX.jl -[![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://AlgebraicJulia.github.io/AlgebraicTemplate.jl/stable) -[![Development Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://AlgebraicJulia.github.io/AlgebraicTemplate.jl/dev) -[![Code Coverage](https://codecov.io/gh/AlgebraicJulia/AlgebraicTemplate.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/AlgebraicJulia/AlgebraicTemplatee.jl) -[![CI/CD](https://github.com/AlgebraicJulia/AlgebraicTemplate.jl/actions/workflows/julia_ci.yml/badge.svg)](https://github.com/AlgebraicJulia/AlgebraicTemplate.jl/actions/workflows/julia_ci.yml) +[![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://AlgebraicJulia.github.io/AlgebraicX.jl/stable) +[![Development Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://AlgebraicJulia.github.io/AlgebraicX.jl/dev) +[![Code Coverage](https://codecov.io/gh/AlgebraicJulia/AlgebraicX.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/AlgebraicJulia/AlgebraicXe.jl) +[![CI/CD](https://github.com/AlgebraicJulia/AlgebraicX.jl/actions/workflows/julia_ci.yml/badge.svg)](https://github.com/AlgebraicJulia/AlgebraicX.jl/actions/workflows/julia_ci.yml) A template repository for making a new AlgebraicJulia package. @@ -27,16 +27,16 @@ A template repository for making a new AlgebraicJulia package. git clone https://github.com/AlgebraicJulia/AlgebraicX.jl.git cd AlgebraicX.jl ``` -5. Rename the file `src/AlgebraicTemplate.jl` to match the name of your new package (e.x. "AlgebraicX") +5. Rename the file `src/AlgebraicX.jl` to match the name of your new package (e.x. "AlgebraicX") ```sh - mv src/AlgebraicTemplate.jl src/AlgebraicX.jl + mv src/AlgebraicX.jl src/AlgebraicX.jl ``` -6. Replace all instances of the word "AlgebraicTemplate" with your new package name (e.x. "AlgebraicX") +6. Replace all instances of the word "AlgebraicX" with your new package name (e.x. "AlgebraicX") ```sh # On linux - git grep -l 'AlgebraicTemplate' | xargs sed -i 's/AlgebraicTemplate/AlgebraicX/g' + git grep -l 'AlgebraicX' | xargs sed -i 's/AlgebraicX/AlgebraicX/g' # On Mac OS X - git grep -l 'AlgebraicTemplate' | xargs sed -i '' -e 's/AlgebraicTemplate/AlgebraicX/g' + git grep -l 'AlgebraicX' | xargs sed -i '' -e 's/AlgebraicX/AlgebraicX/g' ``` 7. Generate a new random version 4 UUID (you can get one here: https://www.uuidgenerator.net/version4) - We will assume for this example that your new UUID is `` diff --git a/docs/Project.toml b/docs/Project.toml index f26c9b1..48ee948 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,4 +1,4 @@ [deps] -AlgebraicTemplate = "b66562e1-fa90-4e8b-9505-c909188fab76" +DiagrammaticEquations = "b66562e1-fa90-4e8b-9505-c909188fab76" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" diff --git a/docs/literate/literate_example.jl b/docs/literate/literate_example.jl index bd5f878..079c756 100644 --- a/docs/literate/literate_example.jl +++ b/docs/literate/literate_example.jl @@ -4,7 +4,7 @@ # # First we want to load our package with `using` -using AlgebraicTemplate +using DiagrammaticEquations # ## Using `hello()` # diff --git a/docs/make.jl b/docs/make.jl index 862f5f7..473fa66 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -4,8 +4,8 @@ using Literate const literate_dir = joinpath(@__DIR__, "literate") const generated_dir = joinpath(@__DIR__, "src", "generated") -@info "Loading AlgebraicTemplate" -using AlgebraicTemplate +@info "Loading DiagrammaticEquations" +using DiagrammaticEquations const no_literate = "--no-literate" in ARGS if !no_literate @@ -14,8 +14,8 @@ if !no_literate # Set Literate.jl config if not being compiled on recognized service. config = Dict{String,String}() if !(haskey(ENV, "GITHUB_ACTIONS") || haskey(ENV, "GITLAB_CI")) - config["nbviewer_root_url"] = "https://nbviewer.jupyter.org/github/AlgebraicJulia/AlgebraicTemplate.jl/blob/gh-pages/dev" - config["repo_root_url"] = "https://github.com/AlgebraicJulia/AlgebraicTemplate.jl/blob/main/docs" + config["nbviewer_root_url"] = "https://nbviewer.jupyter.org/github/AlgebraicJulia/AlgebraicX.jl/blob/gh-pages/dev" + config["repo_root_url"] = "https://github.com/AlgebraicJulia/AlgebraicX.jl/blob/main/docs" end for (root, dirs, files) in walkdir(literate_dir) @@ -34,13 +34,13 @@ end @info "Building Documenter.jl docs" makedocs( - modules=[AlgebraicTemplate], + modules=[DiagrammaticEquations], format=Documenter.HTML(), - sitename="AlgebraicTemplate.jl", + sitename="AlgebraicX.jl", doctest=false, checkdocs=:none, pages=Any[ - "AlgebraicTemplate.jl"=>"index.md", + "AlgebraicX.jl"=>"index.md", "Examples"=>Any[ "generated/literate_example.md", ], @@ -51,6 +51,6 @@ makedocs( @info "Deploying docs" deploydocs( target="build", - repo="github.com/AlgebraicJulia/AlgebraicTemplate.jl.git", + repo="github.com/AlgebraicJulia/DiagrammaticEquations.jl.git", branch="gh-pages" ) diff --git a/docs/src/api.md b/docs/src/api.md index 38b269d..87b9db1 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -1,5 +1,5 @@ # Library Reference ```@autodocs -Modules = [AlgebraicTemplate] +Modules = [DiagrammaticEquations] ``` diff --git a/docs/src/index.md b/docs/src/index.md index d3f8de2..29bb77c 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,7 +1,7 @@ -# AlgebraicTemplate.jl +# DiagrammaticEquations.jl ```@meta -CurrentModule = AlgebraicTemplate +CurrentModule = DiagrammaticEquations ``` -`AlgebraicTemplate.jl` is a Julia library for... +`DiagrammaticEquations.jl` is a Julia library for... diff --git a/src/AlgebraicTemplate.jl b/src/AlgebraicTemplate.jl deleted file mode 100644 index e86b143..0000000 --- a/src/AlgebraicTemplate.jl +++ /dev/null @@ -1,15 +0,0 @@ -""" Some description of ths package -""" -module AlgebraicTemplate - -export hello - -using Catlab - -""" hello(name::String) - -Returns the string "Hello, !" where `` is replaced with the provided parameter -""" -hello(name::String) = string("Hello, ", name, "!") - -end diff --git a/test/Project.toml b/test/Project.toml index 8f5725b..f267256 100644 --- a/test/Project.toml +++ b/test/Project.toml @@ -1,3 +1,3 @@ [deps] -AlgebraicTemplate = "b66562e1-fa90-4e8b-9505-c909188fab76" +DiagrammaticEquations = "b66562e1-fa90-4e8b-9505-c909188fab76" Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" diff --git a/test/runtests.jl b/test/runtests.jl index d5acb48..1348967 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -1,6 +1,6 @@ using Test -using AlgebraicTemplate +using AlgebraicX @testset "Core" begin include("core.jl")