Skip to content

Commit 89f3201

Browse files
authored
Update README.md
1 parent f3b0dc0 commit 89f3201

File tree

1 file changed

+4
-33
lines changed

1 file changed

+4
-33
lines changed

README.md

Lines changed: 4 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# DistributedFactorGraphs.jl
22

3-
Release v0.7 | Dev | Coverage | Docs
4-
---------|-----|----------|------
5-
[![Build Status](https://travis-ci.org/JuliaRobotics/DistributedFactorGraphs.jl.svg?branch=release/v0.7)](https://travis-ci.org/JuliaRobotics/DistributedFactorGraphs.jl) | [![Build Status](https://travis-ci.org/JuliaRobotics/DistributedFactorGraphs.jl.svg?branch=master)](https://travis-ci.org/JuliaRobotics/DistributedFactorGraphs.jl) | [![Codecov Status](https://codecov.io/gh/JuliaRobotics/DistributedFactorGraphs.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaRobotics/DistributedFactorGraphs.jl) | [![docs](https://img.shields.io/badge/docs-latest-blue.svg)](http://juliarobotics.github.io/DistributedFactorGraphs.jl/latest/)
3+
Release v0.7 | Dev | Coverage | DFG Docs | Caesar Docs |
4+
---------|-----|----------|------|------------
5+
[![Build Status](https://travis-ci.org/JuliaRobotics/DistributedFactorGraphs.jl.svg?branch=release/v0.7)](https://travis-ci.org/JuliaRobotics/DistributedFactorGraphs.jl) | [![Build Status](https://travis-ci.org/JuliaRobotics/DistributedFactorGraphs.jl.svg?branch=master)](https://travis-ci.org/JuliaRobotics/DistributedFactorGraphs.jl) | [![Codecov Status](https://codecov.io/gh/JuliaRobotics/DistributedFactorGraphs.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaRobotics/DistributedFactorGraphs.jl) | [![docs](https://img.shields.io/badge/docs-latest-blue.svg)](http://juliarobotics.github.io/DistributedFactorGraphs.jl/latest/) | [![docs](https://img.shields.io/badge/docs-latest-blue.svg)](http://juliarobotics.github.io/Caesar.jl/latest/)
66

77
DistributedFactorGraphs.jl provides a flexible factor graph API for use in the [Caesar.jl](https://github.com/JuliaRobotics/Caesar.jl) ecosystem. The package supplies:
88
* A standardized API for interacting with factor graphs
@@ -37,38 +37,9 @@ Both drivers support the same functions, so choose which you want to use when cr
3737

3838
```julia
3939
# In-memory DFG
40-
dfg = GraphsDFG{NoSolverParams}()
40+
dfg = LightDFG{NoSolverParams}()
4141
addVariable!(dfg, DFGVariable(:a))
4242
addVariable!(dfg, DFGVariable(:b))
4343
addFactor!(dfg, [v1, v2], DFGFactor{Int, :Symbol}(:f1)) # Rather use a RoME-type factor here (e.g. Pose2Pose2) rather than an Int, this is just for demonstrative purposes.
4444
```
4545

46-
```julia
47-
# Neo4j-based DFG
48-
dfg = CloudGraphsDFG{NoSolverParams}("localhost", 7474, "neo4j", "test",
49-
"testUser", "testRobot", "testSession",
50-
nothing,
51-
nothing,
52-
IncrementalInference.decodePackedType)
53-
addVariable!(dfg, DFGVariable(:a))
54-
addVariable!(dfg, DFGVariable(:b))
55-
addFactor!(dfg, [v1, v2], DFGFactor{Int, :Symbol}(:f1)) # Rather use a RoME-type factor here (e.g. Pose2Pose2) rather than an Int, this is just for demonstrative purposes.
56-
```
57-
58-
Please see the documentation for more information on interacting with the factor graph.
59-
60-
## Setting up a Quick Neo4j Database
61-
The simplest way to set up a test database is with Docker. The Neo4j driver currenly doesn't work with Neo4j 4.0, version 3.5 can be used as in this example.
62-
63-
To pull the Neo4j image:
64-
```bash
65-
docker pull neo4j:3.5
66-
```
67-
68-
To run the image with user `neo4j` and password `test`:
69-
70-
```bash
71-
docker run -d --publish=7474:7474 --publish=7687:7687 --env NEO4J_AUTH=neo4j/test neo4j:3.5
72-
```
73-
74-
> **Note** If you just installed docker and having permission issues, please see [this ask Ubuntu forum](https://askubuntu.com/questions/941816/permission-denied-when-running-docker-after-installing-it-as-a-snap).

0 commit comments

Comments
 (0)