diff --git a/CITATION.cff b/CITATION.cff index adf6fb5..7088376 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -11,7 +11,7 @@ authors: - family-names: Szell given-names: Michael orcid: "https://orcid.org/0000-0003-3022-2483" -repository-code: 'https://github.com/NERDSITU/superblockify' +repository-code: 'https://github.com/BikeNetKit/superblockify' url: 'https://superblockify.city/' keywords: - Python diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d2b987..b751ab9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,14 +34,14 @@ the experience for all involved. The community looks forward to your contributio > available [Documentation](https://superblockify.city/). Before you ask a question, it is best to search for -existing [Issues](https://github.com/NERDSITU/superblockify/issues) that might help you. +existing [Issues](https://github.com/BikeNetKit/superblockify/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. If you then still feel the need to ask a question and need clarification, we recommend the following: -- Open an [Issue](https://github.com/NERDSITU/superblockify/issues/new). +- Open an [Issue](https://github.com/BikeNetKit/superblockify/issues/new). - Provide as much context as you can about what you're running into. - Provide project and platform versions (operating system, `pip list`), depending on what seems relevant. @@ -74,7 +74,7 @@ us fix any potential bug as fast as possible. - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in - the [bug tracker](https://github.com/NERDSITU/superblockify/issues?q=label%3Abug). + the [bug tracker](https://github.com/BikeNetKit/superblockify/issues?q=label%3Abug). - Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. - Collect information about the bug: @@ -93,7 +93,7 @@ us fix any potential bug as fast as possible. We use GitHub issues to track bugs and errors. If you run into an issue with the project: -- Open an [Issue](https://github.com/NERDSITU/superblockify/issues/new). (Since we can't +- Open an [Issue](https://github.com/BikeNetKit/superblockify/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) - Explain the behavior you would expect and the actual behavior. @@ -128,7 +128,7 @@ suggestion and find related suggestions. - Make sure that you are using the latest version. - Read the [documentation](https://superblockify.city/) carefully and find out if the functionality is already covered, maybe by an individual configuration. -- Perform a [search](https://github.com/NERDSITU/superblockify/issues) to see if the +- Perform a [search](https://github.com/BikeNetKit/superblockify/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. - Find out whether your idea fits with the scope and aims of the project. It's up to you @@ -142,7 +142,7 @@ suggestion and find related suggestions. #### How Do I Submit a Good Enhancement Suggestion? Enhancement suggestions are tracked -as [GitHub issues](https://github.com/NERDSITU/superblockify/issues). +as [GitHub issues](https://github.com/BikeNetKit/superblockify/issues). - Use a **clear and descriptive title** for the issue to identify the suggestion. - Provide a **step-by-step description of the suggested enhancement** in as many details diff --git a/README.md b/README.md index b3d4078..0ee751b 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,10 @@ [![status](https://joss.theoj.org/papers/87426e988ebd0a6d7f592eb16d1fd209/status.svg)](https://joss.theoj.org/papers/87426e988ebd0a6d7f592eb16d1fd209) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13300610.svg)](https://doi.org/10.5281/zenodo.13300610) -[![Docs](https://github.com/NERDSITU/superblockify/actions/workflows/docs.yml/badge.svg)](https://github.com/NERDSITU/superblockify/actions/workflows/docs.yml) -[![Lint](https://github.com/NERDSITU/superblockify/actions/workflows/lint.yml/badge.svg)](https://github.com/NERDSITU/superblockify/actions/workflows/lint.yml) -[![Test](https://github.com/NERDSITU/superblockify/actions/workflows/test.yml/badge.svg)](https://github.com/NERDSITU/superblockify/actions/workflows/test.yml) -[![codecov](https://codecov.io/gh/NERDSITU/superblockify/branch/main/graph/badge.svg?token=AS72IFT2Q4)](https://codecov.io/gh/NERDSITU/superblockify) +[![Docs](https://github.com/BikeNetKit/superblockify/actions/workflows/docs.yml/badge.svg)](https://github.com/BikeNetKit/superblockify/actions/workflows/docs.yml) +[![Lint](https://github.com/BikeNetKit/superblockify/actions/workflows/lint.yml/badge.svg)](https://github.com/BikeNetKit/superblockify/actions/workflows/lint.yml) +[![Test](https://github.com/BikeNetKit/superblockify/actions/workflows/test.yml/badge.svg)](https://github.com/BikeNetKit/superblockify/actions/workflows/test.yml) +[![codecov](https://codecov.io/gh/BikeNetKit/superblockify/branch/main/graph/badge.svg?token=AS72IFT2Q4)](https://codecov.io/gh/BikeNetKit/superblockify) Source code to `superblockify` an urban street network @@ -44,9 +44,9 @@ conda activate sb_env > 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) +issues, [clone this repository](https://github.com/BikeNetKit/superblockify/archive/refs/heads/main.zip) and create the environment via -the [`environment.yml`](https://github.com/NERDSITU/superblockify/blob/main/environment.yml) +the [`environment.yml`](https://github.com/BikeNetKit/superblockify/blob/main/environment.yml) file: ```bash @@ -71,12 +71,12 @@ sb_env) We provide a minimum working example in two formats: -* [Jupyter notebook (`00-mwe.ipynb`)](https://github.com/NERDSITU/superblockify/blob/main/examples/00-mwe.ipynb) -* [Python script (`00-mwe.py`)](https://github.com/NERDSITU/superblockify/blob/main/examples/00-mwe.py) +* [Jupyter notebook (`00-mwe.ipynb`)](https://github.com/BikeNetKit/superblockify/blob/main/examples/00-mwe.ipynb) +* [Python script (`00-mwe.py`)](https://github.com/BikeNetKit/superblockify/blob/main/examples/00-mwe.py) For a guided start after installation, see the [usage section](https://superblockify.city/usage/) in the documentation. See -the [`examples/`](https://github.com/NERDSITU/superblockify/blob/main/examples/) folder +the [`examples/`](https://github.com/BikeNetKit/superblockify/blob/main/examples/) folder for more example scripts. ## Documentation @@ -87,10 +87,10 @@ about `superblockify`. ## Testing The tests are specified using the `pytest` signature, -see [`tests/`](https://github.com/NERDSITU/superblockify/blob/main/tests/) folder, and +see [`tests/`](https://github.com/BikeNetKit/superblockify/blob/main/tests/) folder, and can be run using a test runner of choice. A pipeline is set up, -see [`.github/workflows/test.yml`](https://github.com/NERDSITU/superblockify/blob/main/.github/workflows/test.yml). +see [`.github/workflows/test.yml`](https://github.com/BikeNetKit/superblockify/blob/main/.github/workflows/test.yml). ## Credits & Funding diff --git a/docs/changelog.rst b/docs/changelog.rst index 6266b15..ece502e 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -29,7 +29,7 @@ Version 1.0.0 (2024-08-12) * 🆕 New features: Betweenness Centrality Cutoff, Reduced path filling. * 🐛 Fixes: notebook formatting, GEOSException in tesselation, missing attribute. * 🔄 Merged pull request: `🌐 Added Betweenness Centrality Cutoff - `_. + `_. * 📝 Misc changes: deactivated colormap logging, unified nodes and edges into one variable. * 📊 Improved analysis scripts @@ -62,8 +62,8 @@ Version 0.2.1 (2023-06-22) resolved to polygons. Normally, only the edges are exported. Added general graph stats with OSM boundary polygon. -.. |codecov-badge| image:: https://codecov.io/gh/NERDSITU/superblockify/branch/main/graph/badge.svg?token=AS72IFT2Q4 - :target: https://codecov.io/gh/NERDSITU/superblockify +.. |codecov-badge| image:: https://codecov.io/gh/BikeNetKit/superblockify/branch/main/graph/badge.svg?token=AS72IFT2Q4 + :target: https://codecov.io/gh/BikeNetKit/superblockify :height: 2ex Version 0.2.0 (2023-06-20) @@ -115,4 +115,4 @@ Version 0.0.0 ************* * See changes before in the repository under the tag `0.0.0 - `_. \ No newline at end of file + `_. \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 7b9c1bc..4745252 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -63,7 +63,7 @@ html_theme = "sphinx_book_theme" html_static_path = ["_static"] html_theme_options = { - "repository_url": "https://github.com/NERDSITU/superblockify/", + "repository_url": "https://github.com/BikeNetKit/superblockify/", "repository_branch": "main", "use_source_button": True, "use_repository_button": True, diff --git a/docs/index.rst b/docs/index.rst index 5bd08bc..2e80bc7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -66,7 +66,7 @@ JOSS paper `doi:10.21105/joss.06798 `__, e. Contributing ============ If you want to contribute to the development of superblockify, please read the -`CONTRIBUTING.md `__ +`CONTRIBUTING.md `__ file. .. toctree:: diff --git a/docs/installation.md b/docs/installation.md index 2e0cb76..6c32601 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -17,9 +17,9 @@ conda activate sb_env > 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) +issues, [clone this repository](https://github.com/BikeNetKit/superblockify/archive/refs/heads/main.zip) and create the environment via -the [`environment.yml`](https://github.com/NERDSITU/superblockify/blob/main/environment.yml) +the [`environment.yml`](https://github.com/BikeNetKit/superblockify/blob/main/environment.yml) file: ```bash diff --git a/docs/usage.myst b/docs/usage.myst index 80eb4a9..2eda154 100644 --- a/docs/usage.myst +++ b/docs/usage.myst @@ -306,6 +306,6 @@ For further settings, see the other attributes in the `Config` class. ``` If you run into any other issues, feel free to look into the [API documentation](api/index), -[Source Code](https://github.com/NERDSITU/superblockify/), +[Source Code](https://github.com/BikeNetKit/superblockify/), activate debug logs `sb.config.set_log_level("DEBUG")` -or finally [open a new issue](https://github.com/NERDSITU/superblockify/issues/new). \ No newline at end of file +or finally [open a new issue](https://github.com/BikeNetKit/superblockify/issues/new). \ No newline at end of file diff --git a/examples/01-getting-started.ipynb b/examples/01-getting-started.ipynb index 76b18a6..8ab9151 100644 --- a/examples/01-getting-started.ipynb +++ b/examples/01-getting-started.ipynb @@ -452,9 +452,9 @@ }, "source": [ "If you run into any other issues, feel free to look into the [API documentation](api/index),\n", - "[Source Code](https://github.com/NERDSITU/superblockify/),\n", + "[Source Code](https://github.com/BikeNetKit/superblockify/),\n", "activate debug logs `sb.config.set_log_level(\"DEBUG\")`\n", - "or finally [open a new issue](https://github.com/NERDSITU/superblockify/issues/new)." + "or finally [open a new issue](https://github.com/BikeNetKit/superblockify/issues/new)." ] } ], diff --git a/pyproject.toml b/pyproject.toml index 1b10e5d..bb6d281 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -50,7 +50,7 @@ dependencies = [ [project.urls] Documentation = "https://superblockify.city/" -Repository = "https://github.com/NERDSITU/superblockify" +Repository = "https://github.com/BikeNetKit/superblockify" Changelog = "https://superblockify.city/changelog/" [project.optional-dependencies]