Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ GrowBikeNet is built on top of `OSMnx`_ and `GeoPandas`_. It takes one mandatory
* The edges which link the seed points are routed on the street network.
* A metric is computed for all edges. By default this is betweenness centrality.
* The edges are ordered by this metric, denoting the importance and order of links to build.
* Data is exported to a results folder, by default to geojson files, but gpkg is also possible. Exported files are the city boundary, the seed points, and the grown edges (and the existing bicycle network, if used).
* Data is exported to a results folder, by default to gpkg files, but geojson or shp is also possible. Exported files are the city boundary, the seed points, and the grown edges (and the existing bicycle network, if used).
* Optional, plots are generated in the results folder for each edge.


Expand Down
7 changes: 7 additions & 0 deletions docs/source/reference_developer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,47 +3,54 @@ Developer reference

This is the complete developer reference for the GrowBikeNet package. If you are looking for an introduction to GrowBikeNet, read the :doc:`getting_started` guide.


growbikenet.growbikenet
-----------------------

.. automodule:: growbikenet.growbikenet
:members:


growbikenet.constants
---------------------

.. automodule:: growbikenet.constants
:members:
:private-members:


growbikenet.osm
---------------

.. automodule:: growbikenet.osm
:members:
:private-members:


growbikenet.utils
-----------------

.. automodule:: growbikenet.utils
:members:
:private-members:


growbikenet.settings
--------------------

.. automodule:: growbikenet.settings
:members:
:private-members:


growbikenet.visualization
-------------------------

.. automodule:: growbikenet.visualization
:members:
:private-members:


growbikenet._procedure
----------------------

Expand Down
15 changes: 9 additions & 6 deletions docs/source/reference_user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,26 @@ This is the user reference for the GrowBikeNet package. If you are looking for a

The standard way to import the GrowBikeNet package is via ``import growbikenet as gbn``. The main ``growbikenet()`` function below is then called via ``gbn.growbikenet()``, see the :doc:`mwe`.


growbikenet.growbikenet
-----------------------

.. automodule:: growbikenet.growbikenet
:members:
:no-index:

growbikenet.osm
---------------

.. automodule:: growbikenet.osm
:members:
:no-index:

growbikenet.settings
--------------------

.. automodule:: growbikenet.settings
:members:
:no-index:


growbikenet.osm
---------------

.. automodule:: growbikenet.osm
:members:
:no-index:
Loading
Loading