Merge branch 'master' of https://github.com/flow-project/flow into as…

…hkan-development

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,53 @@
+---
+name: Bug report
+labels: bug
+about: You can report a bug in Flow
+
+---
+
+<!--
+Thank you for contributing to Flow!
+
+Please make sure you keep the title of your bug report short and informative,
+and that you fill in the following template accurately (don't forget to remove
+the fields that you do not use and the example texts!).
+-->
+
+## Bug Description
+
+A clear and concise description of the bug and what you expected to happen.
+
+## Bug Reproduce
+
+<!-- DELETE THIS SECTION IF NOT APPLICABLE -->
+File in which the bug occurred: `file.py`
+
+The exact command that you did run that caused the bug:
+`command`
+
+## Output Log
+
+<!-- DELETE THIS SECTION IF NOT APPLICABLE -->
+Full error output log:
+
+```
+error log
+```
+
+## Screenshots
+
+<!-- DELETE THIS SECTION IF NOT APPLICABLE -->
+
+<!-- If possible, add screenshots to help explain the bug -->
+
+Screenshots:
+
+![picture name](https://link/to/screenshot)
+
+## Versions
+
+<!-- DELETE THIS SECTION IF NOT APPLICABLE -->
+
+- OS: ? (For example, RedHat, macOS Mojave, ...]
+- Flow version: ? (run `python -c "import flow; print(flow.__version__)"`)
+- Flow commit number: ? (run `git log` and copy the commit number)

.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+labels: feature request
+about: You can request a feature to be added to Flow
+
+---
+
+<!--
+
+Thank you for contributing to Flow!
+
+Please make sure you keep the title of your feature request short and informative,
+and that you fill in the following template accurately (don't forget to remove
+the example text).
+-->
+
+## Feature Description
+
+Please provide:
+
+- Clear description of the feature
+- Description of what you expect
+- [optional] Any other context (e.g. pictures)

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,14 @@
+---
+name: Technical question
+title: DO NOT POST THIS.
+about: If you have a question or run into some problem with Flow (e.g. during the installation or when running an example)
+
+---
+
+PLEASE DO NOT ASK YOUR QUESTIONS HERE ON GITHUB!
+
+If you have a question or run into some problem (e.g. during installation or when running an example)
+with Flow, please direct your technical questions to Stack Overflow using the "flow-project" tag.
+
+link: https://stackoverflow.com/questions/tagged/flow-project
+tag: flow-project

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,35 +1,22 @@
 <!--
-Thank you for contributing to Flow! Here are a few guidelines that you should please follow so that your pull request gets reviewed more efficiently:
+Thank you for contributing to Flow! 
 
-1) Make sure your pull request has a short and relevant title
-2) Add relevant labels in the right sidebar (e.g. bug fix, new feature, feature removal, documentation, cleaning, sumo, aimsun...)
-3) Fill the following template as accurately as possible
--->
-
-## Pull request information
+Please make sure you keep the title of your pull request short and informative,
+and that you fill in the following template accurately (don't forget to remove
+the fields that you do not use and the example texts!). You can also add relevant labels in the right
+sidebar.
 
-<!-- 
-- Status: "Ready to merge" or "In development"
-- Kind of changes: The kind of changes this PR introduces; this should reflect the labels in the sidebar
-- Code affected: The general code area(s) affected by the PR (e.g. kernel, scenarios, environments, tests, examples, tutorials...)
-- Related PR/issue (optional): Link to related issues, PRs or branches (see https://help.github.com/en/articles/autolinked-references-and-urls for link formatting)
 -->
 
-- **Status**: Ready to merge / In development
-- **Kind of changes**: ?
-- **Code affected**: ?
-- **Related PR or issue**: (optional)
+## Pull request information
 
----
+- **Status**: ? (ready to merge / in development)
+- **Kind of changes**: ? (bug fix / new feature / documentation...)
+- **Related PR or issue**: ? (optional)
 
 ## Description
 
 <!-- Describe all the changes introduced in this PR; keep it short and informative -->
 <!-- If it is a bug fix, describe what the bug was and how you fixed it -->
 
-(general description)
-
-Features:
-- 
-- 
-- 
+? (general description)

.gitignore

@@ -103,7 +103,9 @@ debug/
 .vs/**
 
 # Custom for Aimsun
+flow.ang
 *.ang.lck
-*flow.sqlite
+*.sqlite
 *.ang.old
 *.sang
+

.travis.yml

@@ -7,27 +7,39 @@ python:
 
 os: linux
 
-dist: trusty
+dist: xenial
+
+services:
+  - xvfb
 
 sudo: required
 
 git:
   depth: 1
 
 before_install:
+  # install and run pep8 and docstyle tests
+  - pip install pydocstyle
+  - pydocstyle --convention numpy
+  - pip install flake8
+  - flake8 --version
+  - flake8 --show-source
+
   # Setup conda (needed for opencv, ray dependency)
   - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
   - bash miniconda.sh -b -p $HOME/miniconda
   - export PATH="$HOME/miniconda/bin:$PATH"
   - export TEST_FLAG="True"
+  - conda config --append channels https://repo.anaconda.com/pkgs/free
+  - conda config --append channels https://repo.anaconda.com/pkgs/pro
 
   # Set up requirements for flow
   - conda env create -f environment.yml
   - source activate flow
 
   # [sumo] dependencies and binaries
   - pushd $HOME/build/flow-project
-  -     ./flow/scripts/setup_sumo_ubuntu1404.sh
+  -     ./flow/scripts/setup_sumo_ubuntu1604.sh
   - popd
   - source ~/.bashrc
 
@@ -41,18 +53,13 @@ before_install:
   - ls ../
 
 install:
-  - pip install flake8 .
+  - sudo apt update
+  - sudo apt install -y freeglut3-dev libgl1-mesa-dev libglu1-mesa-dev
+  - pip install -e .
   - pip install coveralls
-  - pip install nose
-  - pip install matplotlib
   - pip install jupyter
 
-before_script:
-  - flake8 --version
-  - flake8 --show-source
-
 script:
-  - python setup.py install
   - nose2 --with-coverage
 
 after_success:

README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.com/flow-project/flow.svg?branch=master)](https://travis-ci.com/flow-project/flow)
 [![Docs](https://readthedocs.org/projects/flow/badge)](http://flow.readthedocs.org/en/latest/)
 [![Coverage Status](https://coveralls.io/repos/github/flow-project/flow/badge.svg?branch=master)](https://coveralls.io/github/flow-project/flow?branch=master)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/flow-project/flow/binder)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/flow-project/flow/blob/master/LICENSE.md)
 
 # Flow
@@ -16,6 +17,7 @@ See [our website](https://flow-project.github.io/) for more information on the a
 - [Documentation](https://flow.readthedocs.org/en/latest/)
 - [Installation instructions](http://flow.readthedocs.io/en/latest/flow_setup.html)
 - [Tutorials](https://github.com/flow-project/flow/tree/master/tutorials)
+- [Binder Build (beta)](https://mybinder.org/v2/gh/flow-project/flow/binder)
 
 # Technical questions
 

docs/source/conf.py

@@ -1,28 +1,33 @@
-# -*- coding: utf-8 -*-
-#
-# Configuration file for the Sphinx documentation builder.
-#
-# This file does only contain a selection of the most common options. For a
-# full list see the documentation:
-# http://www.sphinx-doc.org/en/master/config
+"""Configuration file for the Sphinx documentation builder.
 
-# -- Path setup --------------------------------------------------------------
+This file does only contain a selection of the most common options. For a
+full list see the documentation:
+http://www.sphinx-doc.org/en/master/config
 
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+ -- Path setup ---------------------------------------------------------------
+
+If extensions (or modules to document with autodoc) are in another directory,
+add these directories to sys.path here. If the directory is relative to the
+documentation root, use os.path.abspath to make it absolute, like shown here.
 
+import os
 import sys
-from unittest.mock import MagicMock
+sys.path.insert(0, os.path.abspath('.'))
+"""
+
+import sys
+try:
+    from unittest.mock import MagicMock
+except ImportError:
+    from mock import MagicMock
 
 
 class Mock(MagicMock):
+    """Mock object."""
+
     @classmethod
     def __getattr__(cls, name):
+        """Return a MagicMock object."""
         return MagicMock()