Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/SciRuby/networkx.rb

A Ruby implementation of Python's well known Graph library "networkx"
https://github.com/SciRuby/networkx.rb

network-graph networkx ruby ruby-gem

Last synced: 3 months ago
JSON representation

A Ruby implementation of Python's well known Graph library "networkx"

Awesome Lists containing this project

README

        

# NetworkX.rb

[![Gem Version](https://badge.fury.io/rb/networkx.svg)](https://badge.fury.io/rb/networkx)

[NetworkX](https://networkx.github.io/) is a very popular Python library, that handles various use-cases of the Graph Data Structure.
This project intends to provide a working alternative to the Ruby community, by closely mimicing as many features as possible.

## List of contents

- [Installing](#installing)
- [Usage](#Usage)
- [Document](#document)
- [Contributing](#contributing)
- [License](#license)

## Installing

- install it yourself as:
```console
$ gem install networkx
```

- Or use Bundler & Gemfile
1. add this line to your application's Gemfile:
```ruby
gem 'networkx'
```
2. And then execute:
```console
$ bundle install
```

## Usage

```ruby
require 'networkx'

g = NetworkX::Graph.new
g.add_edge('start', 'stop')
```

## Document

You can read [Document](https://SciRuby.github.io/networkx.rb/) for this library.

## Contributing

Your contributions are always welcome!
Please have a look at the [contribution guidelines](.github/CONTRIBUTING.md) first. :tada:

## License

The MIT License 2017 - [Athitya Kumar](https://github.com/athityakumar).
Please have a look at the [LICENSE.md](LICENSE.md) for more details.