Merge branch 'main' into hanna_author

.gitignore

@@ -40,3 +40,7 @@ src/plenoptic/version.py
 
 # gets created during install
 build/
+
+# venv
+.venv
+venv

README.md

@@ -1,6 +1,7 @@
 # plenoptic
 
 [![PyPI Version](https://img.shields.io/pypi/v/plenoptic.svg)](https://pypi.org/project/plenoptic/)
+[![Anaconda-Server Badge](https://anaconda.org/conda-forge/plenoptic/badges/version.svg)](https://anaconda.org/conda-forge/plenoptic)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/LabForComputationalVision/plenoptic/blob/main/LICENSE)
 ![Python version](https://img.shields.io/badge/python-3.10|3.11|3.12-blue.svg)
 [![Build Status](https://github.com/LabForComputationalVision/plenoptic/workflows/build/badge.svg)](https://github.com/LabForComputationalVision/plenoptic/actions?query=workflow%3Abuild)
@@ -34,12 +35,21 @@ aimed at validating or falsifying model predictions.
 
 ### Installation
 
-The best way to install `plenoptic` is via `pip`.
+The best way to install `plenoptic` is via `pip`:
 
 ``` bash
 $ pip install plenoptic
 ```
 
+or `conda`:
+
+``` bash
+$ conda install plenoptic -c conda-forge
+```
+
+> [!WARNING]
+> We do not currently support conda installs on Windows, due to the lack of a Windows pytorch package on conda-forge. See [here](https://github.com/conda-forge/pytorch-cpu-feedstock/issues/32) for the status of that issue.
+
 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

docs/conf.py

@@ -52,6 +52,7 @@
     'sphinx.ext.intersphinx',
     'sphinx_copybutton',
     'sphinxemoji.sphinxemoji',
+    'sphinx_inline_tabs'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -94,6 +95,7 @@
 
 numfig = True
 
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

docs/index.rst

@@ -1,6 +1,9 @@
 .. |pypi-shield| image:: https://img.shields.io/pypi/v/plenoptic.svg
 			 :target: https://pypi.org/project/plenoptic/
 
+.. |conda-shield| image:: https://anaconda.org/conda-forge/plenoptic/badges/version.svg
+                  :target: https://anaconda.org/conda-forge/plenoptic
+
 .. |license-shield| image:: https://img.shields.io/badge/license-MIT-yellow.svg
                     :target: https://github.com/LabForComputationalVision/plenoptic/blob/main/LICENSE
 
@@ -28,7 +31,7 @@ plenoptic
 *********
 .. _index:
 
-|pypi-shield| |license-shield| |python-version-shield| |build| |zenodo| |codecov| |binder|
+|pypi-shield| |conda-shield| |license-shield| |python-version-shield| |build| |zenodo| |codecov| |binder|
 
 
 .. image:: images/plenoptic_logo_wide.svg
@@ -53,6 +56,12 @@ The best way to install ``plenoptic`` is via ``pip``::
 
 $ pip install plenoptic
 
+or ``conda``::
+
+$ conda install plenoptic -c conda-forge
+
+.. warning::  We do not currently support conda installs on Windows, due to the lack of a Windows pytorch package on conda-forge. See `here <https://github.com/conda-forge/pytorch-cpu-feedstock/issues/32>`_ for the status of that issue.
+
 See the :ref:`install` page for more details, including how to set up an isolated
 virtual environment (recommended).