deps: add remote extra for paramiko and migrate install docs to uv#686
Merged
Conversation
FBumann
force-pushed
the
deps/paramiko-optional-extra
branch
from
f6f511b to
d8eef20
Compare
- Add `remote = ["paramiko"]` to `[project.optional-dependencies]` so the SSH backend can be installed without dragging it into the base install (follows the `oetc` extra convention). - Replace `pip install paramiko` in `solve-on-remote.ipynb` with `uv pip install "linopy[remote]"`. - Migrate the remaining `pip install` snippets in README.md and the Sphinx docs (`prerequisites.rst`, `contributing.rst`, `gpu-acceleration.rst`) to their `uv pip install` / `uv sync --extra` equivalents. Addresses follow-up requested in PR #681. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
FBumann
force-pushed
the
deps/paramiko-optional-extra
branch
from
d8eef20 to
7948e5b
Compare
FabianHofmann
requested changes
May 18, 2026
Collaborator
FabianHofmann
left a comment
FabianHofmann
left a comment
There was a problem hiding this comment.
wonderful. while we are on it there are two other items we should address in this pr
| and run it via `pre-commit <https://pre-commit.com/index.html>`_: | ||
|
|
||
| 1. Installation ``conda install -c conda-forge pre-commit`` or ``pip install pre-commit`` | ||
| 1. Installation ``conda install -c conda-forge pre-commit`` or ``uv pip install pre-commit`` |
Collaborator
There was a problem hiding this comment.
could you add pre-commit to the dev extension, then we don't need this step anymore
Collaborator
Author
There was a problem hiding this comment.
Added the setup step instead
| .. code:: bash | ||
|
|
||
| pip install highspy | ||
| uv pip install highspy |
Collaborator
There was a problem hiding this comment.
highspy is already in dev and solvers, so no need for this step anymore
Both are already pulled in by the relevant extras (`pre-commit` via `dev`, `highspy` via `solvers` and `dev`), so the standalone install snippets only add noise. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
FabianHofmann
approved these changes
May 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up on the discussion in #681 about the SSH prerequisites.
remote = ["paramiko"]to[project.optional-dependencies](mirrors theoetcextra convention) so the SSH backend can be installed vialinopy[remote]instead of telling users topip install paramikoseparately.pip install paramikoinexamples/solve-on-remote.ipynbwithuv pip install "linopy[remote]".pip installsnippets inREADME.md,doc/prerequisites.rst,doc/contributing.rst, anddoc/gpu-acceleration.rstto theiruv pip install/uv sync --extra ...equivalents, per FabianHofmann's suggestion in docs: reorganize toctree into basic→advanced sections, rewrite user-guide landing #681 that "pip install ...calls should be replaced with proper uv commands".Kept the
conda install -c conda-forge ...alternatives untouched since those are real alternative install paths, not pip/uv variants.The
devextra is intentionally left as-is in this PR —paramikoandtypes-paramikostill ship there so the existing developer workflow does not change. Happy to dedupe (dropparamikofromdevand rely on--extra remote) as a follow-up if preferred.🤖 Generated with Claude Code
Comment
I migrated everything from pip to
uv pip .... DO you agree?