Skip to content

Commit 111d701

Browse files
committed
Doc: Migrate Installation instructions to conda-forge
1 parent 6e5f9bb commit 111d701

File tree

3 files changed

+14
-21
lines changed

3 files changed

+14
-21
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ as [GitHub issues](https://github.com/NERDSITU/superblockify/issues).
165165

166166
If you prefer to directly put your enhancement into code, you are welcome to submit a
167167
pull request.
168-
When doing so, we reccomend to set up your development environment with the
168+
When doing so, we recommend setting up your development environment with the
169169
development dependencies and an editable installation of the package, like so:
170170

171171
```bash

README.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,13 @@ or [`micromamba`](https://mamba.readthedocs.io/en/latest/installation/micromamba
3535
to create the virtual environment `sb_env`:
3636

3737
```bash
38-
conda create -n sb_env -c conda-forge python=3.12 osmnx=1.9.2
38+
conda create -n sb_env -c conda-forge superblockify
39+
conda activate sb_env
3940
```
4041

41-
> **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.
42+
> **Note:** While `pip` can install `superblockify`, it's not officially supported due
43+
> to potential issues with C dependencies needed for OSMnx.
44+
> If unsure, use `conda` as instructed above to avoid problems.
4245
4346
*Alternatively*, or if you run into
4447
issues, [clone this repository](https://github.com/NERDSITU/superblockify/archive/refs/heads/main.zip)
@@ -48,13 +51,6 @@ file:
4851

4952
```bash
5053
conda env create --file environment.yml
51-
```
52-
53-
### Install package
54-
55-
Next, activate the environment and install the package:
56-
57-
```bash
5854
conda activate sb_env
5955
pip install superblockify
6056
```

docs/installation.md

+8-11
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,22 @@ or [`micromamba`](https://mamba.readthedocs.io/en/latest/installation/micromamba
88
to create the virtual environment `sb_env`:
99

1010
```bash
11-
conda create -n sb_env -c conda-forge python=3.12 osmnx=1.9.2
11+
conda create -n sb_env -c conda-forge superblockify
12+
conda activate sb_env
1213
```
1314

14-
> **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.
15+
> **Note:** While `pip` can install `superblockify`, it's not officially supported due
16+
> to potential issues with C dependencies needed for OSMnx. If unsure, use `conda` as
17+
> instructed above to avoid problems.
1518
16-
*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
19+
*Alternatively*, or if you run into
20+
issues, [clone this repository](https://github.com/NERDSITU/superblockify/archive/refs/heads/main.zip)
21+
and create the environment via
1722
the [`environment.yml`](https://github.com/NERDSITU/superblockify/blob/main/environment.yml)
1823
file:
1924

2025
```bash
2126
conda env create --file environment.yml
22-
```
23-
24-
### Install package
25-
26-
Next, activate the environment and install the package:
27-
28-
```bash
2927
conda activate sb_env
3028
pip install superblockify
3129
```
@@ -42,5 +40,4 @@ python -m ipykernel install --user --name=sb_env
4240
This allows you to run Jupyter with the kernel `sb_env` (Kernel > Change Kernel >
4341
sb_env)
4442

45-
4643
For a guided start after installation, see the following [Usage section](#usage).

0 commit comments

Comments
 (0)