Skip to content

Commit 7282768

Browse files
authored
Update README.md (#836)
Remove mentions to coiled runtime
1 parent fa43b3c commit 7282768

File tree

1 file changed

+5
-81
lines changed

1 file changed

+5
-81
lines changed

README.md

Lines changed: 5 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,14 @@
1-
# Coiled Runtime
1+
# Coiled Benchmarks
22

33
[![Tests](https://github.com/coiled/benchmarks/actions/workflows/tests.yml/badge.svg)](https://github.com/coiled/benchmarks/actions/workflows/tests.yml)
44
[![Linting](https://github.com/coiled/benchmarks/actions/workflows/lint.yml/badge.svg)](https://github.com/coiled/benchmarks/actions/workflows/lint.yml)
55
[![Benchmarks](https://shields.io/badge/-Benchmarks-blue)](https://benchmarks.coiled.io)
66

7-
The Coiled Runtime is a conda metapackage which makes it easy to get started with Dask.
7+
Set of Dask benchmarks run daily at scale in Coiled Clusters.
88

9-
## Install
9+
## Test Locally (for developers)
1010

11-
`coiled-runtime` can be installed with `conda`:
12-
13-
```bash
14-
conda install -c conda-forge coiled-runtime
15-
```
16-
17-
or with `pip`:
18-
19-
```bash
20-
pip install coiled-runtime
21-
```
22-
23-
24-
**Nightly builds**
25-
26-
`coiled-runtime` has nightly conda packages for testing purposes.
27-
You can install a nightly version of `coiled-runtime` with:
28-
29-
```bash
30-
conda install -c coiled/label/dev -c dask/label/dev coiled-runtime
31-
```
32-
33-
## Build
34-
35-
To build and install `coiled-runtime` locally, use the following steps:
36-
37-
```bash
38-
# Have a local copy of the `coiled-runtime` repository
39-
git clone https://github.com/coiled/benchmarks
40-
cd coiled-runtime
41-
42-
# Make sure conda-build is installed
43-
conda install -c conda-forge conda-build
44-
45-
# Build the metapackage
46-
conda build recipe -c conda-forge --output-folder dist/conda --no-anaconda-upload
47-
48-
# Install the built `coiled-runtime` metapackage
49-
conda install -c ./dist/conda/ -c conda-forge coiled-runtime
50-
```
51-
52-
## Test
53-
54-
The `coiled-runtime` test suite can be run locally with the following steps:
11+
The `coiled benchmarks` test suite can be run locally with the following steps:
5512

5613
1. Ensure your local machine is authenticated to use the `dask-engineering` Coiled account and
5714
the Coiled Dask Engineering AWS S3 account.
@@ -69,7 +26,7 @@ See the section below on creating pull requests.
6926

7027
## Benchmarking
7128

72-
The `coiled-runtime` test suite contains a series of pytest fixtures which enable
29+
The `coiled-benchmarks` test suite contains a series of pytest fixtures which enable
7330
benchmarking metrics to be collected and stored for historical and regression analysis.
7431
By default, these metrics are not collected and stored, but they can be enabled
7532
by including the `--benchmark` flag in your pytest invocation.
@@ -242,39 +199,6 @@ grant access to secrets for forked repositories](https://docs.github.com/en/acti
242199
**please submit pull requests directly from the `coiled/benchmarks` repository,
243200
not a personal fork**.
244201

245-
## Release
246-
247-
To issue a new `coiled-runtime` release:
248-
249-
1. Locally update the `coiled-runtime` version and package pinnings specified in `recipe/meta.yaml`.
250-
- When updating package version pinnings (in particular `dask` and `distributed`)
251-
confirm there are no reported large scale stability issues (e.g. deadlocks) or
252-
performance regressions on the `dask` / `distributed` issue trackers or offline
253-
reports.
254-
2. Open a pull request to the `coiled-runtime` repository titled "Release X.Y.Z" with these changes
255-
(where `X.Y.Z` is replaced with the actual version for the release).
256-
3. After all CI builds have passed the release pull request can be merged.
257-
4. Add a new git tag for the release by following the steps below on your local machine:
258-
259-
```bash
260-
# Pull in changes from the Release X.Y.Z PR
261-
git checkout main
262-
git pull origin main
263-
264-
# Set release version number
265-
export RELEASE=X.Y.Z
266-
# Create and push release tag
267-
git tag -a $RELEASE -m "Version $RELEASE"
268-
git push origin main --tags
269-
```
270-
271-
5. Update the `coiled-runtime` package on conda-forge by opening a pull request to the
272-
[`coiled-runtime` conda-forge feedstock](https://github.com/conda-forge/coiled-runtime-feedstock)
273-
which updates the `coiled-runtime` version and package version pinnings.
274-
- Note that pull requests to conda-forge feedstocks must come from a fork.
275-
- Reset the build number back to `0` if it isn't already.
276-
- For more information on updating conda-forge packages, see the
277-
[conda-forge docs](https://conda-forge.org/docs/maintainer/updating_pkgs.html).
278202

279203
## License
280204

0 commit comments

Comments
 (0)