Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Migrate Installation instructions to conda-forge #98

Merged
merged 3 commits into from
Aug 21, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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 CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
```
Expand Down
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
19 changes: 8 additions & 11 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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).