Skip to content

Commit 5c66fb0

Browse files
authored
Merge pull request #124 from Kai-Striega/config-benchmarks-with-spin
MAINT: Config benchmarks to work with asv (again)
2 parents 6c40b8e + 646f292 commit 5c66fb0

File tree

3 files changed

+8
-18
lines changed

3 files changed

+8
-18
lines changed

asv.conf.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939

4040
// List of branches to benchmark. If not provided, defaults to "master"
4141
// (for git) or "default" (for mercurial).
42-
"branches": ["main"],
42+
"branches": ["HEAD"],
4343

4444
// The DVCS being used. If not set, it will be automatically
4545
// determined from "repo" by looking at the protocol in the URL

doc/source/dev/running_the_benchmarks.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,12 @@
22

33
This document outlines how to setup and run the benchmarks using [asv](https://asv.readthedocs.io/en/v0.6.1/).
44

5-
## Installing asv
6-
7-
`asv` can be installed with poetry via the `bench` group to install the bench group run:
8-
9-
```shell
10-
poetry install --with=bench
11-
```
12-
13-
This will install ``asv`` into your poetry environment.
14-
155
## Running the benchmarks
166

177
To run the benchmarks with ``asv``, simply enter:
188

199
```shell
20-
poetry run asv run
10+
asv run
2111
```
2212

2313
## Viewing the results
@@ -27,13 +17,13 @@ There are two steps to viewing the results locally. The results need to be publi
2717
To publish the results use:
2818

2919
```shell
30-
poetry run asv publish
20+
asv publish
3121
```
3222

3323
And then to view the results:
3424

3525
```shell
36-
poetry run asv preview
26+
asv preview
3727
```
3828

3929
This will launch a local web browser from which you can view the results
@@ -43,7 +33,7 @@ This will launch a local web browser from which you can view the results
4333
One common use case is to use ``asv`` in development, there are several useful flags that should be used:
4434

4535
```shell
46-
poetry run asv --python=same --quick --dry-run
36+
asv --python=same --quick --dry-run
4737
```
4838

4939
We are adding three flags, these flags are:

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ name = "numpy-financial"
1111
version = "2.0.0"
1212
requires-python = ">=3.10"
1313
description = "Simple financial functions"
14-
license = "BSD-3-Clause"
15-
authors = ["Travis E. Oliphant et al."]
16-
maintainers = ["Numpy Financial Developers <numpy-discussion@python.org>"]
14+
license = {file = "LICENSE.txt"}
15+
authors = [{name = "Travis E. Oliphant et al."}]
16+
maintainers = [{ name = "Numpy Financial Developers", email = "numpy-discussion@python.org" }]
1717
readme = "README.md"
1818
homepage = "https://numpy.org/numpy-financial/latest/"
1919
repository = "https://github.com/numpy/numpy-financial"

0 commit comments

Comments
 (0)