From 2c001bcd7500c305e8b6af73721cf4fd43e3990a Mon Sep 17 00:00:00 2001 From: Emily Miller Date: Fri, 5 Jan 2024 15:27:47 -0800 Subject: [PATCH 1/4] update docs with conda forge --- README.md | 7 +++++++ docs/docs/index.md | 6 ++++++ docs/docs/installation.md | 8 ++++---- 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 81719bbc..0bbb46b6 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ CyFi: Cyanobacteria Finder ============================== [![PyPI](https://img.shields.io/pypi/v/cyfi.svg)](https://pypi.org/project/cyfi/) +[![conda-forge](https://img.shields.io/conda/vn/conda-forge/cyfi.svg)](https://anaconda.org/conda-forge/cyfi) [![tests](https://github.com/drivendataorg/cyfi/workflows/tests/badge.svg?branch=main)](https://github.com/drivendataorg/cyfi/actions?query=workflow%3Atests+branch%3Amain) [![codecov](https://codecov.io/gh/drivendataorg/cyfi/branch/main/graph/badge.svg)](https://codecov.io/gh/drivendataorg/cyfi) @@ -19,6 +20,12 @@ Install CyFi with pip: pip install cyfi ``` +Note: if you're on a Mac, you should install from conda-forge instead. + +``` +conda install -c conda-forge cyfi -y +``` + For detailed instructions for those installing python for the first time, see the [Installation](https://cyfi.drivendata.org/installation/) page. ### Generate batch predictions diff --git a/docs/docs/index.md b/docs/docs/index.md index dc7ecdf8..41275303 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -26,6 +26,12 @@ Install CyFi with pip: pip install cyfi ``` +Note: if you're on a Mac, you should install from conda-forge instead. + +``` +conda install -c conda-forge cyfi -y +``` + For detailed instructions for those installing python for the first time, see the [Installation](installation.md) docs. ### Generate batch predictions diff --git a/docs/docs/installation.md b/docs/docs/installation.md index 2528b7b6..a6e55710 100644 --- a/docs/docs/installation.md +++ b/docs/docs/installation.md @@ -39,7 +39,7 @@ Once the Miniconda installation has finished, ``` $ pip show cyfi Name: cyfi -Version: 0.1.0 +Version: 1.1.2 Summary: CyFi is a Python package to estimate cyanobacteria density in small, inland water bodies using Sentinel-2 satellite imagery. ``` @@ -64,14 +64,14 @@ Once the Miniconda installation has finished, 1. Open the terminal by typing ⌘+space (to open spotlight search) and then typing "Terminal". Hit enter. -2. Type `pip install cyfi` and hit enter +2. Type `conda install -c conda-forge cyfi` and hit enter 3. To check that CyFi has been installed, run `pip show cyfi` ``` $ pip show cyfi Name: cyfi -Version: 0.1.0 +Version: 1.1.2 Summary: CyFi is a Python package to estimate cyanobacteria density in small, inland water bodies using Sentinel-2 satellite imagery. ``` @@ -102,6 +102,6 @@ Summary: CyFi is a Python package to estimate cyanobacteria density in small, in ``` $ pip show cyfi Name: cyfi -Version: 0.1.0 +Version: 1.1.2 Summary: CyFi is a Python package to estimate cyanobacteria density in small, inland water bodies using Sentinel-2 satellite imagery. ``` From 43c9eaf20cd3b8ff51bdcf2d93352bad588bafcc Mon Sep 17 00:00:00 2001 From: Emily Miller Date: Fri, 5 Jan 2024 15:40:05 -0800 Subject: [PATCH 2/4] tweak --- README.md | 2 +- docs/docs/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0bbb46b6..ab0dcb3b 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Install CyFi with pip: pip install cyfi ``` -Note: if you're on a Mac, you should install from conda-forge instead. +If you're on a Mac, you should install from conda-forge instead: ``` conda install -c conda-forge cyfi -y diff --git a/docs/docs/index.md b/docs/docs/index.md index 41275303..22e25d20 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -26,7 +26,7 @@ Install CyFi with pip: pip install cyfi ``` -Note: if you're on a Mac, you should install from conda-forge instead. +If you're on a Mac, you should install from conda-forge instead: ``` conda install -c conda-forge cyfi -y From cb10e8285c62b7e340a8b6941c17dc057399390c Mon Sep 17 00:00:00 2001 From: Emily Miller Date: Fri, 5 Jan 2024 18:45:49 -0800 Subject: [PATCH 3/4] code review feedback --- README.md | 6 ++++-- docs/docs/index.md | 6 ++++-- docs/docs/installation.md | 2 +- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ab0dcb3b..877b99fc 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,14 @@ Install CyFi with pip: pip install cyfi ``` -If you're on a Mac, you should install from conda-forge instead: +Alternatively, CyFi can be installed with conda: ``` -conda install -c conda-forge cyfi -y +conda install -c conda-forge cyfi ``` +There is a known issue with the pip installation on M1 Macs due to LightGBM. If you encounter this, we recommend installing CyFi with conda. + For detailed instructions for those installing python for the first time, see the [Installation](https://cyfi.drivendata.org/installation/) page. ### Generate batch predictions diff --git a/docs/docs/index.md b/docs/docs/index.md index 22e25d20..99a9a077 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -26,12 +26,14 @@ Install CyFi with pip: pip install cyfi ``` -If you're on a Mac, you should install from conda-forge instead: +Alternatively, CyFi can be installed with conda: ``` -conda install -c conda-forge cyfi -y +conda install -c conda-forge cyfi ``` +There is a known issue with the pip installation on M1 Macs due to LightGBM. If you encounter this, we recommend installing CyFi with conda. + For detailed instructions for those installing python for the first time, see the [Installation](installation.md) docs. ### Generate batch predictions diff --git a/docs/docs/installation.md b/docs/docs/installation.md index a6e55710..3d75f7bb 100644 --- a/docs/docs/installation.md +++ b/docs/docs/installation.md @@ -64,7 +64,7 @@ Once the Miniconda installation has finished, 1. Open the terminal by typing ⌘+space (to open spotlight search) and then typing "Terminal". Hit enter. -2. Type `conda install -c conda-forge cyfi` and hit enter +2. Type `conda install -c conda-forge cyfi` and hit enter. When prompted with "Proceed ([y]/n)?", hit enter again. 3. To check that CyFi has been installed, run `pip show cyfi` From 9230a610ceb875ed1eb8d1a34422eb753fa4c5c9 Mon Sep 17 00:00:00 2001 From: Emily Miller Date: Fri, 19 Jan 2024 15:44:03 -0800 Subject: [PATCH 4/4] link to issue; use admonition --- README.md | 5 +++-- docs/docs/index.md | 6 ++++-- docs/docs/installation.md | 6 ++++-- docs/mkdocs.yml | 1 + 4 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 877b99fc..bd4459a8 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,9 @@ Read more at [cyfi.drivendata.org](https://cyfi.drivendata.org) ### Install +> [!NOTE] +> There is a known [issue](https://github.com/drivendataorg/cyfi/issues/114) with the pip installation on M1 Macs due to LightGBM. If you're on a Mac, we recommend installing CyFi with conda, shown in the second option below. + Install CyFi with pip: ``` @@ -26,8 +29,6 @@ Alternatively, CyFi can be installed with conda: conda install -c conda-forge cyfi ``` -There is a known issue with the pip installation on M1 Macs due to LightGBM. If you encounter this, we recommend installing CyFi with conda. - For detailed instructions for those installing python for the first time, see the [Installation](https://cyfi.drivendata.org/installation/) page. ### Generate batch predictions diff --git a/docs/docs/index.md b/docs/docs/index.md index 99a9a077..5647ccb0 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -20,6 +20,10 @@ ### Install +!!! note "" + + Note: There is a known [issue](https://github.com/drivendataorg/cyfi/issues/114) with the pip installation on M1 Macs due to LightGBM. If you're on a Mac, we recommend installing CyFi with conda, shown in the second option below. + Install CyFi with pip: ``` @@ -32,8 +36,6 @@ Alternatively, CyFi can be installed with conda: conda install -c conda-forge cyfi ``` -There is a known issue with the pip installation on M1 Macs due to LightGBM. If you encounter this, we recommend installing CyFi with conda. - For detailed instructions for those installing python for the first time, see the [Installation](installation.md) docs. ### Generate batch predictions diff --git a/docs/docs/installation.md b/docs/docs/installation.md index 3d75f7bb..84f0fee4 100644 --- a/docs/docs/installation.md +++ b/docs/docs/installation.md @@ -64,9 +64,11 @@ Once the Miniconda installation has finished, 1. Open the terminal by typing ⌘+space (to open spotlight search) and then typing "Terminal". Hit enter. -2. Type `conda install -c conda-forge cyfi` and hit enter. When prompted with "Proceed ([y]/n)?", hit enter again. +2. Type `conda install -c conda-forge cyfi` and hit enter. -3. To check that CyFi has been installed, run `pip show cyfi` +3. When prompted with "Proceed ([y]/n)?", hit enter again. + +4. To check that CyFi has been installed, run `pip show cyfi` ``` $ pip show cyfi diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index aaf2e254..7ab76b9e 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -14,6 +14,7 @@ nav: - Changelog: "changelog.md" markdown_extensions: + - admonition - toc: permalink: True toc_depth: 3