diff --git a/README.md b/README.md index ab0dcb3..877b99f 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 22e25d2..99a9a07 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 a6e5571..3d75f7b 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`