Skip to content

Commit

Permalink
Merge pull request #124 from Kai-Striega/config-benchmarks-with-spin
Browse files Browse the repository at this point in the history
MAINT: Config benchmarks to work with asv (again)
  • Loading branch information
Kai-Striega committed May 4, 2024
2 parents 6c40b8e + 646f292 commit 5c66fb0
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 18 deletions.
2 changes: 1 addition & 1 deletion asv.conf.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@

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

// The DVCS being used. If not set, it will be automatically
// determined from "repo" by looking at the protocol in the URL
Expand Down
18 changes: 4 additions & 14 deletions doc/source/dev/running_the_benchmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,12 @@

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

## Installing asv

`asv` can be installed with poetry via the `bench` group to install the bench group run:

```shell
poetry install --with=bench
```

This will install ``asv`` into your poetry environment.

## Running the benchmarks

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

```shell
poetry run asv run
asv run
```

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

```shell
poetry run asv publish
asv publish
```

And then to view the results:

```shell
poetry run asv preview
asv preview
```

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

```shell
poetry run asv --python=same --quick --dry-run
asv --python=same --quick --dry-run
```

We are adding three flags, these flags are:
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ name = "numpy-financial"
version = "2.0.0"
requires-python = ">=3.10"
description = "Simple financial functions"
license = "BSD-3-Clause"
authors = ["Travis E. Oliphant et al."]
maintainers = ["Numpy Financial Developers <numpy-discussion@python.org>"]
license = {file = "LICENSE.txt"}
authors = [{name = "Travis E. Oliphant et al."}]
maintainers = [{ name = "Numpy Financial Developers", email = "numpy-discussion@python.org" }]
readme = "README.md"
homepage = "https://numpy.org/numpy-financial/latest/"
repository = "https://github.com/numpy/numpy-financial"
Expand Down

0 comments on commit 5c66fb0

Please sign in to comment.