Clarify editable installation step in README#3
Open
xzckay wants to merge 1 commit into
Open
Conversation
jldz9
requested changes
Jun 1, 2026
jldz9
left a comment
jldz9
left a comment
Owner
There was a problem hiding this comment.
Replacing . to ./ in pip install -e .
will improve the readablity and this Note is potentially unnecessary
| cd InSARHub | ||
| conda env create -f environment.yml -n insarhub_dev | ||
| conda activate insarhub_dev | ||
| **Note: |
Owner
There was a problem hiding this comment.
Replacing . to ./ in pip install -e .
will improve the readablity and this Note is potentially unnecessary
| cd InSARHub | ||
| conda env create -f environment.yml -n insarhub_dev | ||
| conda activate insarhub_dev | ||
| **Note: |
| conda env create -f environment.yml -n insarhub_dev | ||
| conda activate insarhub_dev | ||
| **Note: | ||
| Run this command from the repository root directory after activating the Conda environment. |
Owner
There was a problem hiding this comment.
Suggested change
| Run this command from the repository root directory after activating the Conda environment. |
| conda activate insarhub_dev | ||
| **Note: | ||
| Run this command from the repository root directory after activating the Conda environment. | ||
| The trailing "." is required because pip installs the current project in editable mode.** |
Owner
There was a problem hiding this comment.
Suggested change
| The trailing "." is required because pip installs the current project in editable mode.** |
| **Note: | ||
| Run this command from the repository root directory after activating the Conda environment. | ||
| The trailing "." is required because pip installs the current project in editable mode.** | ||
| pip install -e . |
Owner
There was a problem hiding this comment.
Suggested change
| pip install -e . | |
| pip install -e ./ |
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.
This PR improves the installation documentation by clarifying the editable installation step.
Changes:
The change is based on installation testing performed on Windows 11.