From e1d0dffab163e0ba03008b7cf318253f654a7069 Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Thu, 25 Jul 2024 12:17:15 -0400 Subject: [PATCH 1/2] Adds conda install instructions --- README.md | 30 ++++++++++++++++++++++++------ docs/installation.rst | 12 +++++++++--- docs/quickstart.rst | 2 +- 3 files changed, 34 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index aa05c49..d0bd57e 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,31 @@ repo](https://github.com/LabForComputationalVision/pyrtools) # Installation -It's recommended you install from pip: `pip install pyrtools`. +You can install `pyrtools` using either pip: -If you wish to install from the main branch, it's still recommended -to use pip, just run `pip install .` (or `pip install -e .` if you -want the changes you make in the directory to be reflected in your -install) from the root directory of this project. The core of this -code is the C code, and the pip install will compile it nicely. +```sh +pip install pyrtools +``` + +or conda: + +```sh +conda install pyrtools -c conda-forge +``` + +You may also install from source, directly from the git repository. This is +largely useful if you are seeking to modify the code or make contributions. To +do so, clone the repository and run `pip install`. On Mac or Linux, that looks +like: + +``` sh +git clone https://github.com/LabForComputationalVision/pyrtools.git +cd pyrtools/ +pip install . +``` + +You may also want an editable install, `pip install -e .`, in which case changes +you make in the source code will be reflected in your install. # Pyramid resources diff --git a/docs/installation.rst b/docs/installation.rst index d3d63b9..841ce9a 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -3,18 +3,24 @@ Installation ************ -There are two ways to install pyrtools: via the ``pip`` package management -system, or directly from source. +You can install pyrtools via the ``pip`` package management system, via +``conda``, or directly from source. .. attention:: Windows support was added in version 1.0.3. If you are on Windows and get an installation error, make sure you are installing the newest version. Recommended =========== -In a shell, please run:: +We recommend using either ``pip`` or ``conda``. + +To install using ``pip``, run the following in a shell:: pip install pyrtools +To install using ``conda``, run the following in a shell:: + + conda install pyrtools -c conda-forge + From source =========== diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 0afdaca..da07c00 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -1,7 +1,7 @@ Quick Start ************* -On Linux or macOS, open a shell and run:: +Open a shell and run:: pip install pyrtools From bf51f0519154946167003a3c19a23fc762d90aa1 Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Thu, 25 Jul 2024 12:19:48 -0400 Subject: [PATCH 2/2] adds conda shields --- README.md | 1 + docs/index.rst | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d0bd57e..d745aef 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # pyrtools: tools for multi-scale image processing [![PyPI Version](https://img.shields.io/pypi/v/pyrtools.svg)](https://pypi.org/project/pyrtools/) +[![Anaconda-Server Badge](https://anaconda.org/conda-forge/pyrtools/badges/version.svg)](https://anaconda.org/conda-forge/pyrtools) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/LabForComputationalVision/pyrtools/blob/main/LICENSE) ![Python version](https://img.shields.io/badge/python-3.8|3.9|3.10|3.11|3.12-blue.svg) [![Build Status](https://github.com/LabForComputationalVision/pyrtools/workflows/build/badge.svg)](https://github.com/LabForComputationalVision/pyrtools/actions?query=workflow%3Abuild) diff --git a/docs/index.rst b/docs/index.rst index 4923dfd..defe515 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,9 @@ .. |pypi-shield| image:: https://img.shields.io/pypi/v/pyrtools.svg :target: https://pypi.org/project/pyrtools/ +.. |conda-shield| image:: https://anaconda.org/conda-forge/pyrtools/badges/version.svg + :target: https://anaconda.org/conda-forge/pyrtools + .. |license-shield| image:: https://img.shields.io/badge/license-MIT-yellow.svg :target: https://github.com/LabForComputationalVision/pyrtools/blob/main/LICENSE @@ -23,7 +26,7 @@ pyrtools ==================================== -|pypi-shield| |license-shield| |python-version-shield| |build| |binder| |doi| +|pypi-shield| |conda-shield| |license-shield| |python-version-shield| |build| |binder| |doi| Pyrtools is a python package for multi-scale image processing, adapted from Eero Simoncelli's `matlabPyrTools