Skip to content

Commit

Permalink
Add more instructions in README (dev builds) (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
benbovy authored Mar 9, 2023
1 parent 0b7d3bb commit e8bf2e5
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,17 @@ This library is at an early stage of development.

- Python
- Numpy
- s2geography
- s2geometry
- [s2geography](https://github.com/paleolimbot/s2geography)
- [s2geometry](https://github.com/google/s2geometry)

Additional requirements when building spherely from source:

- C++ compiler supporting C++17 standard
- CMake
- [scikit-build-core](https://github.com/scikit-build/scikit-build-core)

(Note: C++11 or C++14 should work too but we have no plan to maintain
compatibility with those older standards)

## Installation

Expand All @@ -29,7 +38,7 @@ spherely from source.

## Setting up a development environment using conda

After cloning this repo, create a conda environment using the ci/environment.yml
After cloning this repo, create a conda environment using the `ci/environment.yml`
file with the required dependencies:

```
Expand All @@ -44,6 +53,14 @@ $ cd spherely
$ python -m pip install . -v --no-build-isolation
```

Note that you can specify a build directory in order to avoid rebuilding the
whole library from scratch each time after editing the code (requires
scikit-build-core v0.2.0+):

```
$ python -m pip install . -v --no-build-isolation --config-settings build-dir=build/skbuild
```

Run the tests:

```
Expand All @@ -54,12 +71,9 @@ $ pytest . -v

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


Clone and install `s2geography` (https://github.com/paleolimbot/s2geography):

```
$ git clone https://github.com/paleolimbot/s2geography
$ cmake -S s2geography -B s2geography/build -DCMAKE_CXX_STANDARD=17 -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX
$ cmake --build s2geography/build
$ cmake --install s2geography/build
```
```

0 comments on commit e8bf2e5

Please sign in to comment.