Skip to content

Commit a5063f2

Browse files
docs: Add installation of nightly wheels instructions (#3080)
* Add installation instructions for the awkward-cpp and awkward nightly wheels to the contributing / developer documentation under the releases section.
1 parent 87d2191 commit a5063f2

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,3 +303,14 @@ To make an `awkward` release:
303303
3. A `docs/switcher.json` entry must be added for new minor/major versions.
304304

305305
Pushes that modify `docs/switcher.json` on `main` will automatically be synchronised with AWS.
306+
307+
#### Nightly wheels
308+
309+
Nightly wheels of `awkward-cpp` and `awkward` are built and published to the [Scientific Python Nightly Wheels Anaconda Cloud organization](https://anaconda.org/scientific-python-nightly-wheels).
310+
As the `awkward-cpp` and `awkward` nightly wheels do not include version control system information, they will have the same version numbers as the last released versions on the public PyPI. To avoid resolution conflicts when installing the nightly wheels, it is recommended to first install `awkward-cpp` and `awkward` from PyPI to get all of their dependencies, then uninstall `awkward-cpp` and `awkward` and install the nightly wheels from the Scientific Python nightly index.
311+
312+
```
313+
python -m pip install --upgrade awkward
314+
python -m pip uninstall --yes awkward awkward-cpp
315+
python -m pip install --upgrade --extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple awkward
316+
```

0 commit comments

Comments
 (0)