Document how to run Python examples

[emilk]

There was documentation there, but I couldn't understand it. Thankfully Jeremy told me the magic incantation, so I decided to write it down in a way that I can understand.

I decided to remove the -e examples part of it, since everything seems to work without it and because this is the docs for the examples environment says it is WIP:

rerun/pixi.toml

Lines 39 to 40 in 0ac38a4

	# Example environment (WIP)
	examples = ["examples-common", "maturin-build"]

Checklist

• I have read and agree to Contributor Guide and the Code of Conduct
• I've included a screenshot or gif (if applicable)
• I have tested the web demo (if applicable):
  • Using examples from latest main build: rerun.io/viewer
  • Using full set of examples from nightly build: rerun.io/viewer
• The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
• If applicable, add a new check to the release checklist!

• PR Build Summary
• Recent benchmark results
• Wasm size tracking

To run all checks from main, comment on the PR with @rerun-bot full-check.

[github-actions]

Deployed docs

Commit	Link
0e74ba1	https://landing-kbqhxnndq-rerun.vercel.app/docs

[abey79]

Although that might work, I'm not convinced it's simpler, and it's certainly not how it was intended.

[abey79]

well that's not really the intended way. All examples are already installed in the examples environment, which just needs to have a compatible rerun-sdk there, so:

pixi run -e examples py-build
pixi run -e examples minimal

[abey79]

Likewise.

pixi run -e examples pip install rerun-sdk==0.15.1
pixi run -e examples minimal

[emilk]

It seems like @abey79 convinced @jleibs that pixi shell is not the best recommendation, and that the summary should be

pixi run -e examples py-build
pixi run -e examples minimal

[abey79]

It seems like @abey79 convinced @jleibs that pixi shell is not the best recommendation, and that the summary should be

pixi run -e examples py-build
pixi run -e examples minimal

To clarify, pixi shell is fine. What I find inappropriate is to advertise using pixi's default environment as a recipient to install random stuff, including examples. Our pixi.toml declares an examples environment that is made for that, and offers isolation from the other pixi environments.

So both are perfectly fine imo:

pixi run -e examples py-build
pixi run -e examples minimal

and:

pixi shell -e examples
pixi run py-build
pixi run minimal

The latter case works because pixi run recognises that one of its environment has been activated and uses it instead of default.

[emilk]

Closed by #6466 (review)