From 111d701f4191fd0f281a1ffe3f4587fd0585aae8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlson=20Moses=20B=C3=BCth?= Date: Tue, 20 Aug 2024 11:05:27 +0200 Subject: [PATCH 1/3] Doc: Migrate Installation instructions to `conda-forge` --- CONTRIBUTING.md | 2 +- README.md | 14 +++++--------- docs/installation.md | 19 ++++++++----------- 3 files changed, 14 insertions(+), 21 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 43c43bd..5d2b987 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -165,7 +165,7 @@ as [GitHub issues](https://github.com/NERDSITU/superblockify/issues). If you prefer to directly put your enhancement into code, you are welcome to submit a pull request. -When doing so, we reccomend to set up your development environment with the +When doing so, we recommend setting up your development environment with the development dependencies and an editable installation of the package, like so: ```bash diff --git a/README.md b/README.md index dd2d57a..25f8429 100644 --- a/README.md +++ b/README.md @@ -35,10 +35,13 @@ or [`micromamba`](https://mamba.readthedocs.io/en/latest/installation/micromamba to create the virtual environment `sb_env`: ```bash -conda create -n sb_env -c conda-forge python=3.12 osmnx=1.9.2 +conda create -n sb_env -c conda-forge superblockify +conda activate sb_env ``` -> **Note:** While `pip` can install OSMnx, it's not officially supported due to potential issues with C dependencies. If unsure, use `conda` as instructed above to avoid problems. +> **Note:** While `pip` can install `superblockify`, it's not officially supported due +> to potential issues with C dependencies needed for OSMnx. +> If unsure, use `conda` as instructed above to avoid problems. *Alternatively*, or if you run into issues, [clone this repository](https://github.com/NERDSITU/superblockify/archive/refs/heads/main.zip) @@ -48,13 +51,6 @@ file: ```bash conda env create --file environment.yml -``` - -### Install package - -Next, activate the environment and install the package: - -```bash conda activate sb_env pip install superblockify ``` diff --git a/docs/installation.md b/docs/installation.md index 86ba8bc..2e0cb76 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -8,24 +8,22 @@ or [`micromamba`](https://mamba.readthedocs.io/en/latest/installation/micromamba to create the virtual environment `sb_env`: ```bash -conda create -n sb_env -c conda-forge python=3.12 osmnx=1.9.2 +conda create -n sb_env -c conda-forge superblockify +conda activate sb_env ``` -> **Note:** While `pip` can install OSMnx, it's not officially supported due to potential issues with C dependencies. If unsure, use `conda` as instructed above to avoid problems. +> **Note:** While `pip` can install `superblockify`, it's not officially supported due +> to potential issues with C dependencies needed for OSMnx. If unsure, use `conda` as +> instructed above to avoid problems. -*Alternatively*, or if you run into issues, [clone this repository](https://github.com/NERDSITU/superblockify/archive/refs/heads/main.zip) and create the environment via +*Alternatively*, or if you run into +issues, [clone this repository](https://github.com/NERDSITU/superblockify/archive/refs/heads/main.zip) +and create the environment via the [`environment.yml`](https://github.com/NERDSITU/superblockify/blob/main/environment.yml) file: ```bash conda env create --file environment.yml -``` - -### Install package - -Next, activate the environment and install the package: - -```bash conda activate sb_env pip install superblockify ``` @@ -42,5 +40,4 @@ python -m ipykernel install --user --name=sb_env This allows you to run Jupyter with the kernel `sb_env` (Kernel > Change Kernel > sb_env) - For a guided start after installation, see the following [Usage section](#usage). \ No newline at end of file From 6518a9d2479dd1ecee51b8d3ca089f5b68fb229e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlson=20Moses=20B=C3=BCth?= Date: Tue, 20 Aug 2024 11:39:39 +0200 Subject: [PATCH 2/3] Doc: Add badges and _How to cite_ --- docs/index.rst | 38 +++++++++++++++++++++++++++++++++++--- 1 file changed, 35 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index b94ac44..b2a27f8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,9 +4,34 @@ :width: 1121 :alt: superblockify logo -*************************** -superblockify documentation -*************************** +.. raw:: html + +
+ +.. |spacer| raw:: html + +
+ +.. list-table:: + :widths: auto + :header-rows: 0 + :align: center + + * - .. image:: https://joss.theoj.org/papers/10.21105/joss.06798/status.svg + :target: https://doi.org/10.21105/joss.06798 + :alt: JOSS status + - |spacer| + - .. image:: https://img.shields.io/conda/vn/conda-forge/superblockify.svg + :target: https://anaconda.org/conda-forge/superblockify + :alt: Conda version + - |spacer| + - .. image:: https://img.shields.io/pypi/pyversions/superblockify + :target: https://pypi.org/project/superblockify/ + :alt: Python version + - |spacer| + - .. image:: https://img.shields.io/pypi/l/superblockify + :target: https://pypi.org/project/superblockify/ + :alt: License On these pages you can find documentation for superblockify. @@ -41,6 +66,13 @@ With the advent of new computational tools and datasets, there is an opportunity The target audience for `superblockify` includes urban planners, researchers in urban studies, data scientists interested in urban data, and policymakers involved in urban development. By providing a tool for Superblock analysis, `superblockify` aims to support these professionals in their work towards creating safer, quieter, and more environmentally friendly urban environments. +How to cite +=========== +If you use `superblockify` in your research, please cite the +JOSS paper `doi:10.21105/joss.06798 `__, e.g.: + + Büth et al., (2024). superblockify: A Python Package for Automated Generation, Visualization, and Analysis of Potential Superblocks in Cities. Journal of Open Source Software, 9(100), 6798, https://doi.org/10.21105/joss.06798 + Contributing ============ If you want to contribute to the development of superblockify, please read the From 5f53ea7fa24b5e4f4da692960deeb0075c0baa31 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlson=20Moses=20B=C3=BCth?= Date: Wed, 21 Aug 2024 11:21:18 +0200 Subject: [PATCH 3/3] Doc: Add github handles to `README.md` --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 25f8429..b3d4078 100644 --- a/README.md +++ b/README.md @@ -94,9 +94,10 @@ see [`.github/workflows/test.yml`](https://github.com/NERDSITU/superblockify/blo ## Credits & Funding -* Carlson M. Büth (Implementation) -* Anastassia Vybornova (Supervision) -* Michael Szell (Concept) +* Carlson M. Büth, [@cbueth](https://github.com/cbueth) (Implementation) +* Anastassia Vybornova, [@anastassiavybornova](https://github.com/anastassiavybornova) + (Supervision) +* Michael Szell, [@mszell](https://github.com/mszell) (Concept) Funded by the European Union, [EU Horizon grant JUST STREETS](https://cordis.europa.eu/project/id/101104240) \ No newline at end of file