Merge branch 'master' into doc-cleanup

.travis.yml

@@ -7,16 +7,15 @@ python:
 
 matrix:
   include:
-    - python: '3.7'  # temp solution until python 3.7 is more cleanly supported
+    - python: "3.7"  # temp solution until travis supports python 3.7 more cleanly
       dist: xenial
       sudo: true
-  allow_failures:
-    - python: '3.7'  # dependencies are blocking installation
-  fast_finish: true
 
 install:
   - pip install .
   - pip install -r requirements-dev.txt
+  - # extra tests run if urbansim is present, but it can't install with python 3.7
+  - if [ "$TRAVIS_PYTHON_VERSION" != "3.7" ]; then pip install urbansim; fi
   - pip list
   - pip show choicemodels
 

docs/source/getting-started.rst

@@ -16,13 +16,13 @@ ChoiceModels was created in 2016, with contributions from Sam Maurer (maurer@urb
 Installation
 ------------
 
-ChoiceModels is tested with Python 2.7, 3.5, and 3.6. It should work with Python 3.7 as well, but you won't be able to intall some related UDST libraries like UrbanSim and Orca. 
+ChoiceModels is tested with Python 2.7, 3.5, 3.6, and 3.7. It should run on any platform. 
 
 
 Production releases
 ~~~~~~~~~~~~~~~~~~~
 
-ChoiceModels can be installed using the Pip or Conda package managers.
+ChoiceModels can be installed using the Pip or Conda package managers. We recommend Conda because it resolves dependency conflicts better.
 
 .. code-block:: python
 

requirements-dev.txt

@@ -1,6 +1,8 @@
+# requirements for development and testing
+
 coverage >= 4.5
 coveralls >= 1.3
 pytest >= 3.4
-urbansim >= 3.1
+# urbansim >= 3.1  # additional tests will run if urbansim is installed
 sphinx
 sphinx_rtd_theme

tests/test_mnl_new.py

@@ -9,7 +9,6 @@
 
 from pandas.testing import assert_frame_equal
 from patsy import dmatrix
-from urbansim.urbanchoice.mnl import mnl_estimate, mnl_simulate
 
 from choicemodels import MultinomialLogit
 from choicemodels.tools import MergedChoiceTable
@@ -43,9 +42,15 @@ def test_mnl(obs, alts):
 def test_mnl_estimation(obs, alts):
     """
     Confirm that estimated params from the new interface match urbansim.urbanchoice.
+    Only runs if the urbansim package has been installed.
     
     """
-
+    try:
+        from urbansim.urbanchoice.mnl import mnl_estimate
+    except:
+        print("Comparison of MNL estimation results skipped because urbansim is not installed")
+        return
+
     model_expression = 'obsval + altval - 1'
     mct = MergedChoiceTable(obs, alts, 'choice')
 
@@ -67,8 +72,15 @@ def test_mnl_estimation(obs, alts):
 def test_mnl_prediction(obs, alts):
     """
     Confirm that fitted probabilities in the new codebase match urbansim.urbanchoice.
+    Only runs if the urbansim package has been installed.
     
     """
+    try:
+        from urbansim.urbanchoice.mnl import mnl_simulate
+    except:
+        print("Comparison of MNL simulation results skipped because urbansim is not installed")
+        return
+
     # produce a fitted model
     mct = MergedChoiceTable(obs, alts, 'choice', 5)
     m = MultinomialLogit(mct, model_expression='obsval + altval - 1')

tests/test_mnl_urbansim.py

@@ -1,6 +1,5 @@
 """
-Test data and results for this are generated
-by the R script at data/mnl_tests.R.
+These tests were brought over from UrbanSim.
 
 """
 from __future__ import division