diff --git a/README.md b/README.md index f4c8839..d6ecf40 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ The Python package `growbikenet` grows an urban bicycle network from scratch or from an existing bicycle network. -The software downloads and pre-processes data from OpenStreetMap, prepares seed points to connect, runs simulations, saves the results, create plots and videos. The source code builds on [the code from the research paper](https://github.com/mszell/bikenwgrowth) _Growing Urban Bicycle Networks_ and on [the code from the research paper](https://github.com/pietrofolco/Data-driven_bicycle_network_planning_for_demand_and_safety) _Data-driven micromobility network planning for demand and safety_. +The software downloads and pre-processes data from OpenStreetMap, prepares seed points to connect, runs simulations, saves the results, creates plots and videos. The source code builds on [the code from the research paper](https://github.com/mszell/bikenwgrowth) _Growing Urban Bicycle Networks_ and on [the code from the research paper](https://github.com/pietrofolco/Data-driven_bicycle_network_planning_for_demand_and_safety) _Data-driven micromobility network planning for demand and safety_. **Publication** (primary): [https://doi.org/10.1038/s41598-022-10783-y](https://doi.org/10.1038/s41598-022-10783-y) **Publication** (secondary): [https://doi.org/10.1177/23998083221135611](https://doi.org/10.1177/23998083221135611) @@ -16,7 +16,7 @@ The software downloads and pre-processes data from OpenStreetMap, prepares seed ### The easy way -The currently best way to install GrowBikeNet is using pip: +The currently default way to install GrowBikeNet is using pip: ``` pip install growbikenet diff --git a/docs/source/conf.py b/docs/source/conf.py index 5622d9c..f57130d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -52,6 +52,7 @@ # path to bib file with references bibtex_bibfiles = ["_static/references.bib"] bibtex_reference_style = "author_year" +bibtex_default_style = 'plain' # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index ed0d6c9..8d0a774 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -8,7 +8,7 @@ Get Started in 4 Steps 2. Read the :ref:`introducing-growbikenet` section below. -3. Run the :doc:`mwe`. +3. To check that the installation worked, run ``python examples/mwe.py`` or the Jupyter :doc:`mwe`. 4. Consult the :doc:`reference_user` for complete details on using the package. diff --git a/docs/source/index.rst b/docs/source/index.rst index b51d08c..5cc8b46 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,7 +10,7 @@ The Python package ``growbikenet`` grows an urban bicycle network from scratch o The software downloads and pre-processes data from OpenStreetMap, prepares seed points to connect, runs simulations, saves the results, -create plots and videos. The source code builds on `the code from the +creates plots and videos. The source code builds on `the code from the research paper `__ *Growing Urban Bicycle Networks* and on `the code from the research paper `__ @@ -49,7 +49,7 @@ Supported by Development of BikeNetKit/GrowBikeNet was supported by the Innovation Fund Denmark and the EU HORIZON grant JUST STREETS. -|Innovation Fund Denmark| |European Union| |JUST STREETS| +|Innovation Fund Denmark|    |European Union|   |JUST STREETS| .. |Innovation Fund Denmark| image:: _static/logo_innovationfund.png :target: https://innovationsfonden.dk/en diff --git a/docs/source/installation.rst b/docs/source/installation.rst index d252fd3..ec547bd 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -5,48 +5,43 @@ Installation The easy way ~~~~~~~~~~~~ -The currently best way to install GrowBikeNet is using pip: +The currently default way to install GrowBikeNet is using pip: :: pip install growbikenet +If this does not work, follow the instructions below. Advanced installations ~~~~~~~~~~~~~~~~~~~~~~ -Set up environment -^^^^^^^^^^^^^^^^^^ - The main step is to set up a virtual environment ``gbnenv`` in which to -install the package, and then to use or run the environment. - -With Pixi -''''''''' - -Installation with `Pixi `__ is -fastest and most stable: +install the package, and then to use or run the environment. Use either of the methods below. -:: +With conda/pip +^^^^^^^^^^^^^^ - pixi init gbnenv - pixi add --pypi growbikenet +Installation with `conda `__ (or the faster `mamba `__). -At this point you can run growbikenet in the environment, for example as -such: +The conda-forge installation is not yet working. Therefore, you need to `clone the +repository `__ +and create the environment via the +``environment.yml`` file: :: - pixi run python examples/mwe.py + conda env create --file environment.yml + conda activate gbnenv + pip install growbikenet -.. - | [NOTE] - | The first time you run code with Pixi, it might take a minute - longer, as Pixi resolves the environment’s dependencies only at - this point. +With Pixi +^^^^^^^^^ -*Alternatively*, or if you run into issues, `clone this +Installation with `Pixi `__. + +First, `clone this repository `__ and create the environment via the ``environment.yml`` file: @@ -55,35 +50,18 @@ and create the environment via the pixi init --import environment.yml -With mamba/conda/pip -'''''''''''''''''''' - -Alternatively to Pixi, use -`mamba `__ or -`conda `__. - - -.. - - | [IMPORTANT] - | As of 2026-05-04, the conda-forge installation is not yet working. - We will remove this note once it works. +At this point you can run growbikenet in the environment, for example as +such: :: - mamba create -n gbnenv -c conda-forge growbikenet - mamba activate gbnenv - -*Alternatively*, or if you run into issues, `clone the -repository `__ -and create the environment via the -``environment.yml`` file: + pixi run python examples/mwe.py -:: +.. - mamba env create --file environment.yml - mamba activate gbnenv - pip install growbikenet + | The first time you run code with Pixi, it might take a minute + longer, as Pixi resolves the environment’s dependencies only at + this point. Run growbikenet in Jupyter lab @@ -91,31 +69,18 @@ Run growbikenet in Jupyter lab After having set up the environment above, if you wish to run growbikenet via `JupyterLab `__, -follow the instructions below. +follow the corresponding instructions below. -With Pixi -^^^^^^^^^ +With conda +^^^^^^^^^^ -Running growbikenet in Jupter lab with -`Pixi `__ is straightforward: +Using `conda `__ (or the faster `mamba `__), run: :: - pixi run jupyter lab - -An instance of Jupyter lab is automatically going to open in your -browser after the environment is built. - -With mamba/conda -^^^^^^^^^^^^^^^^ - -Using mamba/conda, run: - -:: - - mamba activate gbnenv + conda activate gbnenv ipython kernel install --user --name=gbnenv - mamba deactivate + conda deactivate jupyter lab Once Jupyter lab opens, switch the kernel (Kernel > Change Kernel > @@ -136,6 +101,19 @@ Once Jupyter lab opens, switch the kernel (Kernel > Change Kernel > gbnenv) +With Pixi +^^^^^^^^^ + +Running growbikenet in Jupter lab with +`Pixi `__ is straightforward: + +:: + + pixi run jupyter lab + +An instance of Jupyter lab is automatically going to open in your +browser after the environment is built. + Development installation ~~~~~~~~~~~~~~~~~~~~~~~~