Skip to content

Commit

Permalink
minor tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
benbovy committed Dec 11, 2024
1 parent 61841b1 commit 816ee91
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 12 deletions.
4 changes: 0 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,7 @@ geometry library [s2geometry] via the library [s2geography] which provides a

## Contents

- {doc}`install`
- {doc}`api`

```{toctree}
:hidden: true
:maxdepth: 1
install
Expand Down
18 changes: 10 additions & 8 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ and [PyPI](https://pypi.org/project/spherely/).

### Installation of Python binary wheels (PyPI)

Install the binary wheel, e.g., using [pip](https://pip.pypa.io/):
Install the last released binary wheel, e.g., using [pip](https://pip.pypa.io/):

``` sh
$ pip install spherely
```

### Installation of Conda packages (conda-forge)

Install the conda-forge package using
Install the last released conda-forge package using
[conda](https://docs.conda.io/projects/conda/en/stable/):

``` sh
Expand All @@ -28,7 +28,8 @@ $ conda install spherely --channel conda-forge
## Installation from source

Compiling and installing Spherely from source may be useful for development
purpose and/or for using a specific version of S2Geography or S2Geometry.
purpose and/or for building it against a specific version of S2Geography and/or
S2Geometry.

### Requirements

Expand All @@ -49,14 +50,15 @@ All the requirements listed above are available via conda-forge.

After cloning Spherely's [source
repository](https://github.com/benbovy/spherely), create a conda environment
using the `ci/environment.yml` file with the required dependencies:
with the required (and development) dependencies using the
`ci/environment-dev.yml` file:

```sh
$ conda env create -f spherely/ci/environment.yml
$ conda env create -f spherely/ci/environment-dev.yml
$ conda activate spherely-dev
```

Build and install `spherely`:
Build and install Spherely:

```sh
$ cd spherely
Expand Down Expand Up @@ -86,9 +88,9 @@ $ pre-commit install

(Note: you can skip the pre-commit checks with `git commit --no-verify`)

### Using the latest s2geography version
### Using the latest S2Geography version

If you want to compile spherely against the latest version of s2geography, use:
If you want to compile Spherely against the latest version of S2Geography, use:

```sh
$ git clone https://github.com/paleolimbot/s2geography
Expand Down

0 comments on commit 816ee91

Please sign in to comment.