Skip to content

Commit

Permalink
hello, world! this repo will take on some functionality from decapodes
Browse files Browse the repository at this point in the history
  • Loading branch information
quffaro committed Nov 14, 2023
1 parent ad5b4b6 commit 7b4aaa4
Show file tree
Hide file tree
Showing 10 changed files with 35 additions and 44 deletions.
12 changes: 9 additions & 3 deletions Project.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
name = "AlgebraicTemplate"
name = "DiagrammaticEquations.jl"
uuid = "b66562e1-fa90-4e8b-9505-c909188fab76"
license = "MIT"
authors = ["AlgebraicJulia Developer <[email protected]>"]
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"
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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 `<UUID>`
Expand Down
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
@@ -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"
2 changes: 1 addition & 1 deletion docs/literate/literate_example.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#
# First we want to load our package with `using`

using AlgebraicTemplate
using DiagrammaticEquations

# ## Using `hello()`
#
Expand Down
16 changes: 8 additions & 8 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand All @@ -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",
],
Expand All @@ -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"
)
2 changes: 1 addition & 1 deletion docs/src/api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Library Reference

```@autodocs
Modules = [AlgebraicTemplate]
Modules = [DiagrammaticEquations]
```
6 changes: 3 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -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...
15 changes: 0 additions & 15 deletions src/AlgebraicTemplate.jl

This file was deleted.

2 changes: 1 addition & 1 deletion test/Project.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[deps]
AlgebraicTemplate = "b66562e1-fa90-4e8b-9505-c909188fab76"
DiagrammaticEquations = "b66562e1-fa90-4e8b-9505-c909188fab76"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
2 changes: 1 addition & 1 deletion test/runtests.jl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using Test

using AlgebraicTemplate
using AlgebraicX

@testset "Core" begin
include("core.jl")
Expand Down

0 comments on commit 7b4aaa4

Please sign in to comment.