Lightning installation instructions improvements #848
Conversation
|
Hey Isaac, we should wait until #832 is merged before tackling anything here, as the instructions may differ again. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #848 +/- ##
===========================================
- Coverage 97.85% 73.74% -24.11%
===========================================
Files 113 17 -96
Lines 18160 1916 -16244
===========================================
- Hits 17770 1413 -16357
- Misses 390 503 +113 ☔ View full report in Codecov by Sentry. |
If we're doing this just to avoid merge conflicts, all good! Just want to make sure though that the scope of this PR doesn't cover source installation for anything 👍. All good on my side to wait for #832 |
There was a problem hiding this comment.
Instead of having installation instructions replicated in the README and docs, perhaps we could just make the README instructions very briefly redirect to the docs installation
There was a problem hiding this comment.
I think the README instructions provide what's in the installation page (e.g.,
)
There was a problem hiding this comment.
Thanks @isaacdevlugt! Good from my end, although will defer to the perf team for technical review.
| .. code-block:: console | ||
|
|
||
| $ pip install pennylane-lightning[kokkos] | ||
| On most Linux systems, Lightning-Kokkos can be installed via Spack or Docker by following our installation instructions at `pennylane.ai/install <https://pennylane.ai/install/#high-performance-computing-and-gpus>`_. |
There was a problem hiding this comment.
with lightning.kokkos, I believe there may be more cases than qubit/gpu where you need to install from source (e.g., if you want to use GPUs)
There was a problem hiding this comment.
Thanks! Does this sentence need to be modified 🤔?
Co-authored-by: Thomas R. Bromley <[email protected]> Co-authored-by: Josh Izaac <[email protected]>
|
Will be moving these changes to #851 |
Context: Our installation instructions are unclear for users.
Description of the Change: Point to pennylane.ai/install where possible.
Benefits: Better installation instructions and more clarity for users.
Possible Drawbacks: Hopefully none.
Related GitHub Issues: