Skip to content

Commit bb982a0

Browse files
mtfishmanmtfishman
authored
Rename to DerivableInterfaces.jl (#1)
1 parent d194ece commit bb982a0

22 files changed

+95
-75
lines changed

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
name: Derive.jl bug report
3-
about: Create a bug report to help us improve Derive.jl
2+
name: DerivableInterfaces.jl bug report
3+
about: Create a bug report to help us improve DerivableInterfaces.jl
44
title: "[BUG] YOUR SHORT DESCRIPTION OF THE BUG HERE"
55
labels: ["bug"]
66
assignees: ''
@@ -55,8 +55,8 @@ If you provided a minimal code that demonstrates the bug or unexpected behavior,
5555
julia> versioninfo()
5656
[YOUR OUTPUT HERE]
5757
```
58-
- Output from `using Pkg; Pkg.status("Derive")`:
58+
- Output from `using Pkg; Pkg.status("DerivableInterfaces")`:
5959
```julia
60-
julia> using Pkg; Pkg.status("Derive")
60+
julia> using Pkg; Pkg.status("DerivableInterfaces")
6161
[YOUR OUTPUT HERE]
6262
```

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
name: Derive.jl feature request
3-
about: Suggest an idea for Derive.jl
2+
name: DerivableInterfaces.jl feature request
3+
about: Suggest an idea for DerivableInterfaces.jl
44
title: "[ENHANCEMENT] YOUR SHORT DESCRIPTION OF THE FEATURE REQUEST HERE"
55
labels: ["enhancement"]
66
assignees: ''

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Please give a summary of the tests that you added to verify your changes.
3333

3434
# Checklist:
3535

36-
- [ ] My code follows the style guidelines of this project. Please run `using JuliaFormatter; format(".")` in the base directory of the repository (`~/.julia/dev/Derive`) to format your code according to our style guidelines.
36+
- [ ] My code follows the style guidelines of this project. Please run `using JuliaFormatter; format(".")` in the base directory of the repository (`~/.julia/dev/DerivableInterfaces`) to format your code according to our style guidelines.
3737
- [ ] I have performed a self-review of my own code.
3838
- [ ] I have commented my code, particularly in hard-to-understand areas.
3939
- [ ] I have added tests that verify the behavior of the changes I made.

‎Project.toml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
name = "Derive"
2-
uuid = "a07dfc7f-7d04-4eb5-84cc-a97f051f655a"
1+
name = "DerivableInterfaces"
2+
uuid = "6c5e35bf-e59e-4898-b73c-732dcc4ba65f"
33
authors = ["ITensor developers <[email protected]> and contributors"]
4-
version = "0.3.6"
4+
version = "0.3.7"
55

66
[deps]
77
Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
88
ArrayLayouts = "4c555306-a7a7-4459-81d9-ec55ddd5c99a"
9-
BroadcastMapConversion = "4a4adec5-520f-4750-bb37-d5e66b4ddeb2"
109
ExproniconLite = "55351af7-c7e9-48d6-89ff-24e801d99491"
1110
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
1211
MLStyle = "d8e11817-5142-5d16-987a-aa16d5891078"
12+
MapBroadcast = "ebd9b9da-f48d-417c-9660-449667d60261"
1313
TypeParameterAccessors = "7e5a90cf-f82e-492e-a09b-e3e26432c138"
1414

1515
[compat]
1616
Adapt = "4.1.1"
1717
Aqua = "0.8.9"
1818
ArrayLayouts = "1.11.0"
19-
BroadcastMapConversion = "0.1.0"
2019
ExproniconLite = "0.10.13"
2120
LinearAlgebra = "1.10"
2221
MLStyle = "0.4.17"
22+
MapBroadcast = "0.1.5"
2323
SafeTestsets = "0.1"
2424
Suppressor = "0.2"
2525
Test = "1.10"

‎README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Derive.jl
1+
# DerivableInterfaces.jl
22

3-
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/Derive.jl/stable/)
4-
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/Derive.jl/dev/)
5-
[![Build Status](https://github.com/ITensor/Derive.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/Derive.jl/actions/workflows/Tests.yml?query=branch%3Amain)
6-
[![Coverage](https://codecov.io/gh/ITensor/Derive.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/Derive.jl)
3+
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/DerivableInterfaces.jl/stable/)
4+
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/DerivableInterfaces.jl/dev/)
5+
[![Build Status](https://github.com/ITensor/DerivableInterfaces.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/DerivableInterfaces.jl/actions/workflows/Tests.yml?query=branch%3Amain)
6+
[![Coverage](https://codecov.io/gh/ITensor/DerivableInterfaces.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/DerivableInterfaces.jl)
77
[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
88
[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
99

@@ -42,13 +42,14 @@ if you want to use SSH credentials, which can make it so you don't have to enter
4242
Then, the package can be added as usual through the package manager:
4343

4444
```julia
45-
julia> Pkg.add("Derive")
45+
julia> Pkg.add("DerivableInterfaces")
4646
```
4747

4848
## Examples
4949

5050
````julia
51-
using Derive: Derive, @array_aliases, @derive, @interface, interface
51+
using DerivableInterfaces:
52+
DerivableInterfaces, @array_aliases, @derive, @interface, interface
5253
using Test: @test
5354
````
5455

@@ -113,7 +114,7 @@ end
113114
Specify the interface the type adheres to.
114115

115116
````julia
116-
Derive.interface(::Type{<:SparseArrayDOK}) = SparseArrayInterface()
117+
DerivableInterfaces.interface(::Type{<:SparseArrayDOK}) = SparseArrayInterface()
117118
````
118119

119120
Define aliases like `SparseMatrixDOK`, `AnySparseArrayDOK`, etc.
@@ -122,7 +123,7 @@ Define aliases like `SparseMatrixDOK`, `AnySparseArrayDOK`, etc.
122123
@array_aliases SparseArrayDOK
123124
````
124125

125-
Derive the interface for the type.
126+
DerivableInterfaces the interface for the type.
126127

127128
````julia
128129
@derive (T=SparseArrayDOK,) begin

‎benchmark/benchmarks.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using Derive
1+
using DerivableInterfaces
22
using BenchmarkTools
33

44
SUITE = BenchmarkGroup()

‎docs/Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
[deps]
2-
Derive = "a07dfc7f-7d04-4eb5-84cc-a97f051f655a"
2+
DerivableInterfaces = "6c5e35bf-e59e-4898-b73c-732dcc4ba65f"
33
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
44
Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"

‎docs/make.jl

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
1-
using Derive: Derive
1+
using DerivableInterfaces: DerivableInterfaces
22
using Documenter: Documenter, DocMeta, deploydocs, makedocs
33

4-
DocMeta.setdocmeta!(Derive, :DocTestSetup, :(using Derive); recursive=true)
4+
DocMeta.setdocmeta!(
5+
DerivableInterfaces, :DocTestSetup, :(using DerivableInterfaces); recursive=true
6+
)
57

68
include("make_index.jl")
79

810
makedocs(;
9-
modules=[Derive],
11+
modules=[DerivableInterfaces],
1012
authors="ITensor developers <[email protected]> and contributors",
11-
sitename="Derive.jl",
13+
sitename="DerivableInterfaces.jl",
1214
format=Documenter.HTML(;
13-
canonical="https://ITensor.github.io/Derive.jl", edit_link="main", assets=String[]
15+
canonical="https://ITensor.github.io/DerivableInterfaces.jl",
16+
edit_link="main",
17+
assets=String[],
1418
),
1519
pages=["Home" => "index.md"],
1620
)
1721

18-
deploydocs(; repo="github.com/ITensor/Derive.jl", devbranch="main", push_preview=true)
22+
deploydocs(;
23+
repo="github.com/ITensor/DerivableInterfaces.jl", devbranch="main", push_preview=true
24+
)

‎docs/make_index.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
using Literate: Literate
2-
using Derive: Derive
2+
using DerivableInterfaces: DerivableInterfaces
33

44
Literate.markdown(
5-
joinpath(pkgdir(Derive), "examples", "README.jl"),
6-
joinpath(pkgdir(Derive), "docs", "src");
5+
joinpath(pkgdir(DerivableInterfaces), "examples", "README.jl"),
6+
joinpath(pkgdir(DerivableInterfaces), "docs", "src");
77
flavor=Literate.DocumenterFlavor(),
88
name="index",
99
)

‎docs/make_readme.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
using Literate: Literate
2-
using Derive: Derive
2+
using DerivableInterfaces: DerivableInterfaces
33

44
Literate.markdown(
5-
joinpath(pkgdir(Derive), "examples", "README.jl"),
6-
joinpath(pkgdir(Derive));
5+
joinpath(pkgdir(DerivableInterfaces), "examples", "README.jl"),
6+
joinpath(pkgdir(DerivableInterfaces));
77
flavor=Literate.CommonMarkFlavor(),
88
name="README",
99
)

0 commit comments

Comments
 (0)