From 21eef6eee887e6be7ce21c344922754192467ba1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mihai=20Capot=C4=83?= Date: Mon, 9 Dec 2024 12:01:57 -0800 Subject: [PATCH] Document Windows support; fix Conda instructions --- README.rst | 18 +++++------------- docs/installation.rst | 32 ++++++++++++++++++++++++++------ 2 files changed, 31 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index 562aa02f9..34d1c0483 100644 --- a/README.rst +++ b/README.rst @@ -27,23 +27,15 @@ package name), we use ``brainiak``. Quickstart ========== -If you have `Conda `_:: - - conda install -c brainiak -c defaults -c conda-forge brainiak - -Otherwise, or if you want to compile from source, install the requirements (see -`docs/installation`) and then install from PyPI:: +You can install BrainIAK wheels from PyPI on Linux, macOS, and Windows, e.g. using pip:: python3 -m pip install brainiak -Note that to use the ``brainiak.matnormal`` package, you need to install -additional dependencies. As of October 2020, the required versions are not -available as Conda packages, so you should install from PyPI, even when using -Conda:: +If you need MPI, see the installation requirements in `docs/installation`. - python3 -m pip install -U tensorflow tensorflow-probability +If you have `Conda `_, you can also use our Conda packages (not available for Windows). Installing BrainIAK will also install MPI:: -Note that we do not support Windows. + conda install -c brainiak -c conda-forge brainiak Docker @@ -67,7 +59,7 @@ Note that we do not support MPI execution using Docker containers and that perfo Support ======= -If you have a question or feedback, chat with us on `Gitter +If you have a question or feedback, chat with us on `Matrix via Gitter `_ or email our list at brainiak@googlegroups.com. If you find a problem with BrainIAK, you can also `open an issue on GitHub `_. diff --git a/docs/installation.rst b/docs/installation.rst index fbf273ede..9bdae2e6c 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -2,18 +2,38 @@ Installation ============ +Binaries +++++++++ + + +PyPI +==== + +You can install BrainIAK wheels from PyPI on Linux, macOS, and Windows, e.g. using pip:: + + python3 -m pip install brainiak + + +MPI +--- + +On Linux and macOS, there are no MPI4PY binaries in PyPI, so you need to install MPI separately, e.g., following the BrainIAK `source installation instructions <#requirements>`_. + +On Windows, MPI4PY binaries will be installed as BrainIAK dependencies. You can also install an MPI implementation available on PyPI such as Intel MPI:: + + python3 -m pip install impi-rt + + Conda -+++++ +===== Make sure you have the ``conda-forge`` channel active, because some of our dependencies are not available in the default channels. Use our ``brainiak`` channel to install:: - conda install -c brainiak -c defaults -c conda-forge brainiak + conda install -c brainiak -c conda-forge brainiak -Note that `~brainiak.funcalign.sssrm.SSSRM` currently uses Theano, which -requires the Xcode Command Line Tools on `MacOS`_. Source ++++++ @@ -21,8 +41,8 @@ Source Requirements ============ -We support Linux and MacOS with Python version 3.5 or higher. Most of the -dependencies will be installed automatically. However, a few need to be +We support Linux, MacOS, and Windows with Python version 3.9 or higher. Most of +the dependencies will be installed automatically. However, a few need to be installed manually.