Skip to content

Commit 74f89c5

Browse files
committed
Update GraphMakie references and docs
1 parent 8b1235a commit 74f89c5

10 files changed

Lines changed: 24 additions & 26 deletions

NEWS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
Listing news on any major breaking changes in DFG. For regular changes, see integrated Github.com project milestones for DFG.
22

3+
# v0.26
4+
- Graph structure plotting now uses GraphMakie.jl instead of GraphPlot.jl. Update by replacing `using GraphPlot` with `using GraphMakie`.
5+
36
# v0.25
47
- Deprecated nouns:
58
SessionBlobEntry -> GraphBlobEntry

docs/Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Cairo = "159f3aea-2a34-519c-b102-8c37f9878175"
33
Compose = "a81c6b42-2e10-5240-aca2-a61377ecd94b"
44
DistributedFactorGraphs = "b5cc3c7e-6572-11e9-2517-99fb8daf2f04"
55
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
6-
GraphPlot = "a2cc645c-3eea-5389-862e-a155d0052231"
6+
GraphMakie = "1ecd5474-83a3-4783-bb4f-06765db800d2"
77

88
[compat]
99
Documenter = "1"

docs/make.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
using Documenter
2-
using GraphPlot
2+
using GraphMakie
33
using DistributedFactorGraphs
44

55
makedocs(;

docs/src/DrawingGraphs.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Drawing Graphs
22

3-
Graphs can be visualized by using either `GraphPlot` or rendering to .dot files (which can be viewed using xdot).
3+
Graphs can be visualized by using either `GraphMakie` or rendering to .dot files (which can be viewed using xdot).
44

5-
## GraphPlot
5+
## GraphMakie
66

7-
`GraphPlot` plotting is available if `GraphPlot` is imported before DFG is imported. Install `GraphPlot` using the following command:
7+
`GraphMakie` plotting is available if `GraphMakie` is imported before DFG is imported. Install `GraphMakie` using the following command:
88

99
```julia
1010
using Pkg
11-
Pkg.add("GraphPlot")
11+
Pkg.add("GraphMakie")
1212
```
1313

14-
Then bring `GraphPlot` in before DFG:
14+
Then bring `GraphMakie` in before DFG:
1515

1616
```julia
17-
using GraphPlot
17+
using GraphMakie
1818
using DistributedFactorGraphs
1919
```
2020

@@ -38,7 +38,7 @@ f1 = addFactor!(dfg, [:l0; :x1], LinearRelative(Normal(-10.0,5.0)), solvable=1)
3838
plotDFG(dfg)
3939
```
4040

41-
### Rendering GraphPlot to PDF
41+
### Rendering GraphMakie to PDF
4242

4343
The graph can be rendered to PDF, SVG or JPG in the following way by including compose:
4444

@@ -57,12 +57,12 @@ FIXME show graph.svg
5757

5858
### More Information
5959

60-
More information at [GraphPlot.jl](https://github.com/JuliaGraphs/GraphPlot.jl)
60+
More information at [GraphMakie.jl](https://github.com/MakieOrg/GraphMakie.jl)
6161

6262
## Dot Files
6363

6464
Dot files are a standard format for visualizing graphs and applications such as
65-
xdot are available to view the files. Dot plotting does not require `GraphPlot`
65+
xdot are available to view the files. Dot plotting does not require `GraphMakie`
6666
and can be drawn by either:
6767
- Calling [`toDot`](@ref) on any graph to produce a string of the graph
6868
- Calling [`toDotFile`](@ref) on any graph to save it directly to a dotfile

docs/src/func_ref.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Modules = [DistributedFactorGraphs]
4444
Pages = ["entities/DFGFactor.jl"]
4545
```
4646

47-
## DFG Plots [GraphPlot.jl]
47+
## DFG Plots [GraphMakie.jl]
4848

4949
```@autodocs
5050
Modules = [DistributedFactorGraphs]

src/weakdeps_prototypes.jl

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,15 @@
11
"""
22
$(SIGNATURES)
3-
Plots the structure of the factor graph. GraphPlot must be imported before DistributedFactorGraphs for these functions to be available.
3+
Plots the structure of the factor graph. GraphMakie must be imported before DistributedFactorGraphs for these functions to be available.
44
Returns the plot context.
55
66
E.g.
77
```
8-
using GraphPlot
9-
using DistributedFactorGraphs, DistributedFactorGraphs.DFGPlots
8+
using GraphMakie
9+
using DistributedFactorGraphs
1010
# ... Make graph...
11-
# Using GraphViz plotting
1211
plotDFG(fg)
13-
# Save to PDF
14-
using Compose
15-
draw(PDF("/tmp/graph.pdf", 16cm, 16cm), plotDFG(fg))
1612
```
17-
18-
More information at [GraphPlot.jl](https://github.com/JuliaGraphs/GraphPlot.jl)
13+
More information at [GraphMakie.jl](https://github.com/MakieOrg/GraphMakie.jl)
1914
"""
2015
function plotDFG end

test/consol_DataEntryBlobTests.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
if false
22
using Test
3-
using GraphPlot
3+
using GraphMakie
44
using DistributedFactorGraphs
55
using Pkg
66
using Dates

test/interfaceTests.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
if false
22
using Test
3-
using GraphPlot
3+
using GraphMakie
44
using DistributedFactorGraphs
55
using Pkg
66
using Dates

test/plottingTest.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using GraphPlot
1+
using GraphMakie
22
using DistributedFactorGraphs
33
# using DistributedFactorGraphs.DFGPlots
44
using Test
@@ -27,7 +27,7 @@ map(
2727

2828
##
2929

30-
# Using GraphPlot plotting
30+
# Using GraphMakie plotting
3131
plot = plotDFG(dfg)
3232
@test plot !== nothing
3333

test/runtests.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
using Test
2-
using GraphPlot # For plotting tests
2+
using GraphMakie # For plotting tests
33
using DistributedFactorGraphs
44
using Pkg
55
using Dates

0 commit comments

Comments
 (0)