[![Hex Version](]( [![Build Status](](  [![Inline docs](]( [![HexDocs](](


## This project is not yet complete, nor is it ready to be used. If you fancy helping making it complete, be my guest!

FDG is a simple library for producing Force directed graphs. FDG aims to allow you to build a simple tree of relations into a graph that can then be exported in multiple different formats for further analysis.

### FDG plans to support:

 - [x] `dot` syntax for [Graphviz](, and all the image formats it supports as a result.
 - [x] [GraphML]( for use with exporting to tools such as [Gephi](
 - [ ] [Cypher query language]( for importing into supported Graph databases, such as [Neo4j](

## Installation

The package can be installed as:

  1. Add fdg to your list of dependencies in `mix.exs`:

        def deps do
          [{:fdg, "~> 0.0.2"}]

  2. Ensure fdg is started before your application:

        def application do
          [applications: [:fdg]]

## Configuration

### Graphviz

If you wish to use the Graphviz parser, make sure you have Graphviz installed and in your [PATH]( The Graphviz parser uses the `dot` command to produce its images.

## Getting Started

##### TODO - please refer to the [Hexdocs]( for now.

## Further Documentation

Up to date documentation is available on [Hexdocs]( - check there for detailed documentation of all functionality.