Merge pull request #298 from jGaboardi/install_instrs

updating install instructions + version bump

CHANGELOG.md

@@ -1,5 +1,44 @@
 # Changes
 
+Version 1.3.1 (2019-07-29)
+
+We closed a total of 21 issues (enhancements and bug fixes) through 7 pull requests, since our last release on 2019-05-21.
+
+## Issues Closed
+- updating font for "Warning" (#297)
+- update of install instructions in README.md (#295)
+- remove geopandas version stipulation (#291)
+- updating citation langauge (#290)
+- build error beginning (07/01/2019) (#289)
+- update css (#287)
+- update readthedocs.yml? (#284)
+- spaghetti api docs rendering incorrectly (#285)
+- docs table left aligned (#286)
+- remove extra line in .travis.yml (#283)
+- update Changelog (#282)
+- Manually updated CHANGELOG following stable release. (#281)
+- v1.3 release (#264)
+- Bump version 1.3rc2 --> 1.3 (#280)
+
+## Pull Requests
+- updating font for "Warning" (#297)
+- update of install instructions in README.md (#295)
+- updating citation langauge (#290)
+- docs table left aligned (#286)
+- remove extra line in .travis.yml (#283)
+- update Changelog (#282)
+- Bump version 1.3rc2 --> 1.3 (#280)
+
+The following individuals contributed to this release:
+
+- James Gaboardi
+- Wei Kang
+
+-----------------------------------------------------
+
+
+# Changes
+
 Version 1.3 (2019-05-21)
 
 We closed a total of 14 issues (enhancements and bug fixes) through 5 pull requests, since our last release on 2019-05-14.

doc/installation.rst

@@ -1,45 +1,61 @@
 .. Installation
 
-spaghetti supports python `3.6`_ and `3.7`_ only. Please make sure that you are
-operating in a python 3 environment.
+As of version 1.3, spaghetti supports Python `3.6`_ and `3.7`_ only. Please make sure that you are operating in a Python 3 environment.
 
 Installation
 ============
 
-Stable Version (Recommended)
-----------------------------
+Installing with ``conda`` via `spaghetti-feedstock`_ (highly recommended)
+-------------------------------------------------------------------------
 
-Install the latest stable of spaghetti from the `Python Package Index`_ with
-``pip`` from the command line::
+To install ``spaghetti`` and all its dependencies, we recommend using the `conda`_ manager, specifically with the `conda-forge`_ channel. This can be obtained by installing the `Anaconda Distribution`_ (a free Python distribution for data science), or through `miniconda`_ (minimal distribution only containing Python and the ``conda`` package manager). 
 
-  $ pip install spaghetti
-
-Install the latest stable of spaghetti via `conda-forge`_ by running::
+Using `conda`, `spaghetti` can be installed as follows::
 
+  $ conda config --set channel_priority strict
   $ conda install --channel conda-forge spaghetti
 
-or download the source distribution (``.tar.gz``) and decompress it to your
-selected destination. Open a command shell and navigate to the decompressed
-folder::
+
+Installing with `Python Package Index`_
+---------------------------------------
+::
+
+  $ pip install spaghetti
+
+
+*or* download the source distribution (``.tar.gz``) and decompress it to your selected destination. Open a command shell and navigate to the decompressed folder. ::
 
   $ pip install .
 
+.. role:: rubric
+
+**Warning**
+
+When installing via `pip`, you have to ensure that the required dependencies for `spaghetti` are installed on your operating system. Details on how to install these packages are linked `here`_. Using `conda` (above) avoids having to install the dependencies separately.
+
+Install the most current development version of `spaghetti` by running: ::
+
+  $ pip install git+https://github.com/pysal/spaghetti
+
 Development Version
 -------------------
 
 Install the most current development version of spaghetti by running::
 
   $ pip install git+https://github.com/pysal/spaghetti
 
-You can  also `fork`_ the `pysal/spaghetti`_ repo and create a local clone of
-your fork. By making changes to your local clone and submitting a pull request
-to `pysal/spaghetti`_, you can contribute to the giddy development.
+You can  also `fork`_ the `pysal/spaghetti`_ repo and create a local clone of your fork. By making changes to your local clone and submitting a pull request to `pysal/spaghetti`_, you can contribute to the spaghetti development.
 
 |
 
 .. _3.6: https://docs.python.org/3.6/
 .. _3.7: https://docs.python.org/3.7/
+.. _spaghetti-feedstock: https://github.com/conda-forge/spaghetti-feedstock
+.. _conda: https://docs.conda.io/en/latest/
+.. _conda-forge: https://conda-forge.org
+.. _Anaconda Distribution: https://docs.continuum.io/anaconda/
+.. _miniconda: https://docs.conda.io/en/latest/miniconda.html
 .. _Python Package Index: https://pypi.org/project/spaghetti/
-.. _conda-forge: https://github.com/conda-forge/spaghetti-feedstock
 .. _pysal/spaghetti: https://github.com/pysal/spaghetti
-.. _fork: https://help.github.com/articles/fork-a-repo/
+.. _fork: https://help.github.com/articles/fork-a-repo/
+.. _here: https://github.com/pysal/spaghetti#requirements

spaghetti/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.3"
+__version__ = "1.3.1"
 """
 :mod:`spaghetti` --- Spatial Graphs: Networks, Topology, & Inference
 ====================================================================

tools/changelog_1.3.1.md

@@ -0,0 +1,35 @@
+# Changes
+
+Version 1.3.1 (2019-07-29)
+
+We closed a total of 21 issues (enhancements and bug fixes) through 7 pull requests, since our last release on 2019-05-21.
+
+## Issues Closed
+  - updating font for "Warning" (#297)
+  - update of install instructions in README.md (#295)
+  - remove geopandas version stipulation (#291)
+  - updating citation langauge (#290)
+  - build error beginning (07/01/2019) (#289)
+  - update css (#287)
+  - update readthedocs.yml? (#284)
+  - spaghetti api docs rendering incorrectly (#285)
+  - docs table left aligned (#286)
+  - remove extra line in .travis.yml (#283)
+  - update Changelog (#282)
+  - Manually updated CHANGELOG following stable release. (#281)
+  - v1.3 release (#264)
+  - Bump version 1.3rc2 --> 1.3 (#280)
+
+## Pull Requests
+  - updating font for "Warning" (#297)
+  - update of install instructions in README.md (#295)
+  - updating citation langauge (#290)
+  - docs table left aligned (#286)
+  - remove extra line in .travis.yml (#283)
+  - update Changelog (#282)
+  - Bump version 1.3rc2 --> 1.3 (#280)
+
+The following individuals contributed to this release:
+
+  - James Gaboardi
+  - Wei Kang