Skip to content

Commit

Permalink
Doc: Add badges and _How to cite_
Browse files Browse the repository at this point in the history
  • Loading branch information
cbueth committed Aug 20, 2024
1 parent 111d701 commit 6518a9d
Showing 1 changed file with 35 additions and 3 deletions.
38 changes: 35 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,34 @@
:width: 1121
:alt: superblockify logo

***************************
superblockify documentation
***************************
.. raw:: html

<div style="height: 10px;"></div>

.. |spacer| raw:: html

<div style="width: 10px; display: inline-block;"></div>

.. 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.

Expand Down Expand Up @@ -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 <https://doi.org/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
Expand Down

0 comments on commit 6518a9d

Please sign in to comment.