Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add 3.8 as a supported Python version in docs #422

Merged
merged 5 commits into from
Feb 19, 2020
Merged

Add 3.8 as a supported Python version in docs #422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a8a5374
bummping environment.yml python to 3.8
jGaboardi Feb 19, 2020
0a3fb6a
bummping README supported python to 3.8
jGaboardi Feb 19, 2020
2b97735
bumping docsrc supported python to 3.8
jGaboardi Feb 19, 2020
ba62ae2
updating esda docs site in conf.py
jGaboardi Feb 19, 2020
b96db4d
rebuilding docs
jGaboardi Feb 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The following are a selection of some examples that can be launched individually
Installation
------------

As of version 1.3, `spaghetti` officially supports Python [3.6](https://docs.python.org/3.6/) and [3.7](https://docs.python.org/3.7/) only. Please make sure that you are operating in a Python >= 3.6 environment.
As of version 1.4.2, `spaghetti` officially supports Python [3.6](https://docs.python.org/3.6/), [3.7](https://docs.python.org/3.7/), and [3.8](https://docs.python.org/3.8/). Please make sure that you are operating in a Python >= 3.6 environment.

**Installing with `conda` via [`conda-forge`](https://github.com/conda-forge/spaghetti-feedstock) (highly recommended)**

Expand Down
9 changes: 8 additions & 1 deletion docs/_sources/index.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ and usage tutorials are provided here through the links above.
</div>


Development
-----------

Development of `spaghetti` is hosted on GitHub_.


Citing `spaghetti`
------------------

Expand Down Expand Up @@ -82,4 +88,5 @@ If you use PySAL-spaghetti in a scientific publication, we would appreciate usin
References <references>


.. _PySAL: https://github.com/pysal/pysal
.. _PySAL: https://github.com/pysal/pysal
.. _GitHub: https://github.com/pysal/spaghetti
3 changes: 2 additions & 1 deletion docs/_sources/installation.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. Installation

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.
As of version 1.4.2, `spaghetti` supports Python 3.6_, 3.7_, and 3.8_. Please make sure that you are operating in a Python >= 3.6 environment.

Installation
============
Expand Down Expand Up @@ -50,6 +50,7 @@ You can also fork_ the `pysal/spaghetti`_ repo and create a local clone of your

.. _3.6: https://docs.python.org/3.6/
.. _3.7: https://docs.python.org/3.7/
.. _3.8: https://docs.python.org/3.8/
.. _spaghetti-feedstock: https://github.com/conda-forge/spaghetti-feedstock
.. _conda: https://docs.conda.io/en/latest/
.. _conda-forge: https://conda-forge.org
Expand Down
180 changes: 90 additions & 90 deletions docs/generated/spaghetti.Network.html
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/generated/spaghetti.Network.loadnetwork.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ <h1>spaghetti.Network.loadnetwork<a class="headerlink" href="#spaghetti-network-
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>filename</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>The filename where the network is saved.</p>
<dt><strong>filename</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.8/library/stdtypes.html#str" title="(in Python v3.8)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>The filename where the network is saved.</p>
</dd>
</dl>
</dd>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/spaghetti.Network.savenetwork.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ <h1>spaghetti.Network.savenetwork<a class="headerlink" href="#spaghetti-network-
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>filename</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>The filename where the network should be saved. This should
<dt><strong>filename</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.8/library/stdtypes.html#str" title="(in Python v3.8)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>The filename where the network should be saved. This should
be a full path or it will be saved in the current directory.</p>
</dd>
</dl>
Expand Down
20 changes: 10 additions & 10 deletions docs/generated/spaghetti.PointPattern.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,46 +143,46 @@ <h1>spaghetti.PointPattern<a class="headerlink" href="#spaghetti-pointpattern" t
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>in_data</strong><span class="classifier">{<a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><code class="docutils literal notranslate"><span class="pre">list</span></code></a>, <a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#tuple" title="(in Python v3.7)"><code class="docutils literal notranslate"><span class="pre">tuple</span></code></a>, <a class="reference external" href="https://pysal.org/libpysal/generated/libpysal.cg.Point.html#libpysal.cg.Point" title="(in libpysal v4.2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.Point</span></code></a>, <a class="reference external" href="https://geopandas.readthedocs.io/en/latest/reference/geopandas.GeoDataFrame.html#geopandas.GeoDataFrame" title="(in GeoPandas v0.7.0+1.gbe2a8ea)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">geopandas.GeoDataFrame</span></code></a>}</span></dt><dd><p>The input geographic data. Either (1) a path to a shapefile
<dt><strong>in_data</strong><span class="classifier">{<a class="reference external" href="https://docs.python.org/3.8/library/stdtypes.html#str" title="(in Python v3.8)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3.8/library/stdtypes.html#list" title="(in Python v3.8)"><code class="docutils literal notranslate"><span class="pre">list</span></code></a>, <a class="reference external" href="https://docs.python.org/3.8/library/stdtypes.html#tuple" title="(in Python v3.8)"><code class="docutils literal notranslate"><span class="pre">tuple</span></code></a>, <a class="reference external" href="https://pysal.org/libpysal/generated/libpysal.cg.Point.html#libpysal.cg.Point" title="(in libpysal v4.2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.Point</span></code></a>, <a class="reference external" href="https://geopandas.readthedocs.io/en/latest/reference/geopandas.GeoDataFrame.html#geopandas.GeoDataFrame" title="(in GeoPandas v0.7.0+2.g0a1799d)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">geopandas.GeoDataFrame</span></code></a>}</span></dt><dd><p>The input geographic data. Either (1) a path to a shapefile
(str); (2) an iterable containing <code class="docutils literal notranslate"><span class="pre">libpysal.cg.Point</span></code>
objects; (3) a single <code class="docutils literal notranslate"><span class="pre">libpysal.cg.Point</span></code>; or
(4) a <code class="docutils literal notranslate"><span class="pre">geopandas.GeoDataFrame</span></code>.</p>
</dd>
<dt><strong>idvariable</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>Field in the shapefile to use as an ID variable.</p>
<dt><strong>idvariable</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.8/library/stdtypes.html#str" title="(in Python v3.8)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>Field in the shapefile to use as an ID variable.</p>
</dd>
<dt><strong>attribute</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.7)"><span class="xref std std-ref">bool</span></a></span></dt><dd><p>A flag to indicate whether all attributes are tagged to this
<dt><strong>attribute</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.8/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.8)"><span class="xref std std-ref">bool</span></a></span></dt><dd><p>A flag to indicate whether all attributes are tagged to this
class (<code class="docutils literal notranslate"><span class="pre">True</span></code>) or excluded (<code class="docutils literal notranslate"><span class="pre">False</span></code>). Default is <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Attributes</dt>
<dd class="field-even"><dl>
<dt><strong>points</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#dict" title="(in Python v3.7)"><code class="docutils literal notranslate"><span class="pre">dict</span></code></a></span></dt><dd><p>Keys are the point IDs (int). Values are the x,y
<dt><strong>points</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.8/library/stdtypes.html#dict" title="(in Python v3.8)"><code class="docutils literal notranslate"><span class="pre">dict</span></code></a></span></dt><dd><p>Keys are the point IDs (int). Values are the x,y
coordinates (tuple).</p>
</dd>
<dt><strong>npoints</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a></span></dt><dd><p>The number of points.</p>
<dt><strong>npoints</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.8/library/functions.html#int" title="(in Python v3.8)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a></span></dt><dd><p>The number of points.</p>
</dd>
<dt><strong>obs_to_arc</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#dict" title="(in Python v3.7)"><code class="docutils literal notranslate"><span class="pre">dict</span></code></a></span></dt><dd><p>Keys are arc IDs (tuple). Values are snapped point information
<dt><strong>obs_to_arc</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.8/library/stdtypes.html#dict" title="(in Python v3.8)"><code class="docutils literal notranslate"><span class="pre">dict</span></code></a></span></dt><dd><p>Keys are arc IDs (tuple). Values are snapped point information
(<code class="docutils literal notranslate"><span class="pre">dict</span></code>). Within the snapped point information (<code class="docutils literal notranslate"><span class="pre">dict</span></code>)
keys are observation IDs (<code class="docutils literal notranslate"><span class="pre">int</span></code>), and values are snapped
coordinates.</p>
</dd>
<dt><strong>obs_to_vertex</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><code class="docutils literal notranslate"><span class="pre">list</span></code></a></span></dt><dd><p>List of incident network vertices to snapped observation points
<dt><strong>obs_to_vertex</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.8/library/stdtypes.html#list" title="(in Python v3.8)"><code class="docutils literal notranslate"><span class="pre">list</span></code></a></span></dt><dd><p>List of incident network vertices to snapped observation points
converted from a <code class="docutils literal notranslate"><span class="pre">default_dict</span></code>. Originally in the form of
paired left/right nearest network vertices {netvtx1: obs_id1,
netvtx2: obs_id1, netvtx1: obs_id2… netvtx1: obs_idn}, then
simplified to a list in the form
[netvtx1, netvtx2, netvtx1, netvtx2, …].</p>
</dd>
<dt><strong>dist_to_vertex</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#dict" title="(in Python v3.7)"><code class="docutils literal notranslate"><span class="pre">dict</span></code></a></span></dt><dd><p>Keys are observations IDs (<code class="docutils literal notranslate"><span class="pre">int</span></code>). Values are distance lookup
<dt><strong>dist_to_vertex</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.8/library/stdtypes.html#dict" title="(in Python v3.8)"><code class="docutils literal notranslate"><span class="pre">dict</span></code></a></span></dt><dd><p>Keys are observations IDs (<code class="docutils literal notranslate"><span class="pre">int</span></code>). Values are distance lookup
(<code class="docutils literal notranslate"><span class="pre">dict</span></code>). Within distance lookup (<code class="docutils literal notranslate"><span class="pre">dict</span></code>) keys are the two
incident vertices of the arc and values are distance to each of
those arcs.</p>
</dd>
<dt><strong>snapped_coordinates</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#dict" title="(in Python v3.7)"><code class="docutils literal notranslate"><span class="pre">dict</span></code></a></span></dt><dd><p>Keys are the point IDs (int). Values are the snapped x,y
<dt><strong>snapped_coordinates</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.8/library/stdtypes.html#dict" title="(in Python v3.8)"><code class="docutils literal notranslate"><span class="pre">dict</span></code></a></span></dt><dd><p>Keys are the point IDs (int). Values are the snapped x,y
coordinates (tuple).</p>
</dd>
<dt><strong>snap_dist</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.7)"><span class="xref std std-ref">bool</span></a></span></dt><dd><p>Flag as <code class="docutils literal notranslate"><span class="pre">True</span></code> to include the distance from the original
<dt><strong>snap_dist</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3.8/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.8)"><span class="xref std std-ref">bool</span></a></span></dt><dd><p>Flag as <code class="docutils literal notranslate"><span class="pre">True</span></code> to include the distance from the original
location to the snapped location along the network. Default
is <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
</dd>
Expand Down
Loading