From 06bb4a16fcb2bc29dd875df34d9033ccf44483db Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Tue, 20 Feb 2024 12:21:56 -0500 Subject: [PATCH 1/2] adds description of torch/pyrtools dependencies --- README.md | 8 ++++++++ docs/install.rst | 2 ++ 2 files changed, 10 insertions(+) diff --git a/README.md b/README.md index 829bb517..e2574b3a 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,14 @@ The best way to install `plenoptic` is via `pip`. $ pip install plenoptic ``` +We depend on [pytorch](https://pytorch.org/) for automatic differentiation, as +well as [pyrtools](https://pyrtools.readthedocs.io/en/latest/). Installation +should take care of them (along with our other dependencies) automatically, but +if you have an installation problem (especially on a non-Linux operating +system), it is likely the problem lies with one of those packages. [Open an +issue](https://github.com/LabForComputationalVision/plenoptic/issues) and we'll +help you figure out the problem! + See the [installation page](https://plenoptic.readthedocs.io/en/latest/install.html) for more details, including how to set up a virtual environment and jupyter. diff --git a/docs/install.rst b/docs/install.rst index 075c1ad0..2d31bbd3 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -11,6 +11,8 @@ $ conda create --name plenoptic pip python=3.9 $ conda activate plenoptic $ pip install plenoptic +We depend on `pytorch `_ for automatic differentiation, as well as `pyrtools `_. Installation should take care of them (along with our other dependencies) automatically, but if you have an installation problem (especially on a non-Linux operating system), it is likely the problem lies with one of those packages. `Open an issue `_ and we'll help you figure out the problem! + You can also install it directly from source to have a local editable copy. This is most useful for developing (for more info, see `our contributing guide `_) or if you want to use the most cutting-edge version:: $ conda create --name plenoptic pip python=3.9 From f4589404be323dcb1e01f2d1a247c752bf5a763c Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Wed, 21 Feb 2024 12:58:35 -0500 Subject: [PATCH 2/2] small changes to text --- README.md | 12 ++++++------ docs/install.rst | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e2574b3a..a037a333 100644 --- a/README.md +++ b/README.md @@ -35,13 +35,13 @@ The best way to install `plenoptic` is via `pip`. $ pip install plenoptic ``` -We depend on [pytorch](https://pytorch.org/) for automatic differentiation, as -well as [pyrtools](https://pyrtools.readthedocs.io/en/latest/). Installation -should take care of them (along with our other dependencies) automatically, but -if you have an installation problem (especially on a non-Linux operating -system), it is likely the problem lies with one of those packages. [Open an +Our dependencies include [pytorch](https://pytorch.org/) and +[pyrtools](https://pyrtools.readthedocs.io/en/latest/). Installation should take +care of them (along with our other dependencies) automatically, but if you have +an installation problem (especially on a non-Linux operating system), it is +likely that the problem lies with one of those packages. [Open an issue](https://github.com/LabForComputationalVision/plenoptic/issues) and we'll -help you figure out the problem! +try to help you figure out the problem! See the [installation page](https://plenoptic.readthedocs.io/en/latest/install.html) for more details, diff --git a/docs/install.rst b/docs/install.rst index 2d31bbd3..8e35e6db 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -11,7 +11,7 @@ $ conda create --name plenoptic pip python=3.9 $ conda activate plenoptic $ pip install plenoptic -We depend on `pytorch `_ for automatic differentiation, as well as `pyrtools `_. Installation should take care of them (along with our other dependencies) automatically, but if you have an installation problem (especially on a non-Linux operating system), it is likely the problem lies with one of those packages. `Open an issue `_ and we'll help you figure out the problem! +Our dependencies include `pytorch `_ and `pyrtools `_. Installation should take care of them (along with our other dependencies) automatically, but if you have an installation problem (especially on a non-Linux operating system), it is likely that the problem lies with one of those packages. `Open an issue `_ and we'll try to help you figure out the problem! You can also install it directly from source to have a local editable copy. This is most useful for developing (for more info, see `our contributing guide `_) or if you want to use the most cutting-edge version::