Skip to content
Snippets Groups Projects
README.md 646 B
Newer Older
  • Learn to ignore specific revisions
  • Jarrod Pas's avatar
    Jarrod Pas committed
    # pydtn
    
    pydtn is a python module for simulating delay tolerant networks.
    
    Table of Contents:
    * [Installation](#installation)
    * [Development](#development)
    
    ## Installation
    
    pydtn has been run with Python 3.4 and 3.6.
    
    To install pydtn, simply:
    ```
    $ pip install git+https://git.cs.usask.ca/discus/pydtn.git
    ```
    
    ## Usage
    
    There are examples in the `examples/` directory.
    
    ## Development
    
    Clone the repository via ssh:
    ```
    $ git clone git@git.cs.usask.ca:discus/pydtn.git
    ```
    or via https:
    ```
    $ git clone https://git.cs.usask.ca/discus/pydtn.git
    ```
    
    Then install the package and it's dependencies:
    ```
    $ cd pydtn
    $ pip install --editable .
    ```