Skip to content

Commit

Permalink
Merge pull request #273 from jGaboardi/update_docsite
Browse files Browse the repository at this point in the history
Update docsite
  • Loading branch information
jGaboardi authored May 13, 2019
2 parents 6d07d79 + 91f4d86 commit b0f9d9f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
17 changes: 17 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,23 @@ the analysis of network events.
</div>


Citing spaghetti
----------------

If you use PySAL-spaghetti in a scientific publication, we would appreciate citations to the following paper:

Bibtex entry::

@misc{Gaboardi2018,
author = {Gaboardi, James D. and Laura, Jay and Rey, Sergio and Wolf, Levi John and Folch, David C. and Kang, Wei and Stephens, Philip and Schmidt, Charles},
month = {oct},
year = {2018},
title = {pysal/spaghetti},
url = {https://github.com/pysal/spaghetti},
keywords = {graph-theory,network-analysis,python,spatial-networks,topology}
}


.. toctree::
:hidden:
:maxdepth: 3
Expand Down
9 changes: 7 additions & 2 deletions doc/installation.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. Installation
spaghetti supports python `3.5`_ and `3.6`_ only. Please make sure that you are
spaghetti supports python `3.6`_ and `3.7`_ only. Please make sure that you are
operating in a python 3 environment.

Installation
Expand All @@ -14,6 +14,10 @@ Install the latest stable of spaghetti from the `Python Package Index`_ with

$ pip install spaghetti

Install the latest stable of spaghetti via `conda-forge`_ by running::

$ 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::
Expand All @@ -33,8 +37,9 @@ to `pysal/spaghetti`_, you can contribute to the giddy development.

|
.. _3.5: https://docs.python.org/3.5/
.. _3.6: https://docs.python.org/3.6/
.. _3.7: https://docs.python.org/3.7/
.. _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/

0 comments on commit b0f9d9f

Please sign in to comment.