Skip to content

Commit

Permalink
Doc: Migrate Installation instructions to conda-forge
Browse files Browse the repository at this point in the history
  • Loading branch information
cbueth committed Aug 20, 2024
1 parent 6e5f9bb commit 111d701
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 21 deletions.
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
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).

0 comments on commit 111d701

Please sign in to comment.