Skip to content

Commit 1fc50b9

Browse files
committed
Add README section
1 parent 708d9e3 commit 1fc50b9

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,3 +156,22 @@ cd docs
156156
sphinx-autobuild . ./_build/html --watch ../nucleus
157157
```
158158
`sphinx-autobuild` will spin up a server on localhost (port 8000 by default) that will watch for and automatically rebuild a version of the API reference based on your local docstring changes.
159+
160+
161+
## Custom Metrics used in Scale Validate
162+
163+
To install the availalbe metrics for Scale Validate add the optional `metrics` extra.
164+
Note that you might need to install a local GEOS package.
165+
166+
```bash
167+
#Mac OS
168+
brew install geos
169+
# Ubuntu/Debian flavors
170+
apt-get install libgeos-dev
171+
```
172+
173+
`pip install scale-nucleus[metrics]`
174+
175+
To develop it locally use
176+
177+
`poetry install --extra metrics`

0 commit comments

Comments
 (0)