-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix #3; update install instructions in README
- Loading branch information
1 parent
151ffdd
commit c07a2db
Showing
2 changed files
with
13 additions
and
6 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,12 +19,9 @@ The package has been renamed to `wsi`. | |
|
||
While the repository is private, make sure you [exchange SSH keys of the machine with Github.com](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account). | ||
|
||
Then simply install with `pip`: | ||
Then simply install with `pip` (make sure you have a recent enough version with `pip install pip -U`: | ||
```bash | ||
# pip install git+ssh://[email protected]:rendeirolab/wsi.git | ||
git clone [email protected]:rendeirolab/wsi.git | ||
cd wsi | ||
pip install . | ||
pip install git+https://github.com/rendeirolab/wsi.git | ||
``` | ||
|
||
Note that the package uses setuptols-scm for version control and therefore the installation source needs to be a git repository (a zip file of source code won't work). | ||
|
@@ -125,6 +122,16 @@ gdata = slide.as_torch_geometric_data(feats, coords) # from existing features a | |
gdata = slide.as_torch_geometric_data(model_name='resnet18') # without | ||
``` | ||
|
||
## Development | ||
|
||
`wsi` will not be providing new features and future maintenance will be restricted to bugs. Please refer to our newer project [Lazyslide](https://github.com/rendeirolab/LazySlide) for a more modern, interoperable package for the analysis of whole-slide images. | ||
|
||
|
||
To contribute bug maintenance, clone the repository, open an issue in the [issue tracker](https://github.com/rendeirolab/wsi/issues), and submit a pull request. | ||
``` | ||
git clone [email protected]:rendeirolab/wsi.git | ||
``` | ||
|
||
## Reference | ||
Please cite the [paper of the original authors](https://www.nature.com/articles/s41551-020-00682-w): | ||
|
||
|
This file contains 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