From f136aefa35638d5a6605cdff74e2a625d239eaf2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Al=C3=A1n=20Mu=C3=B1oz?= <alan.munoz@ed.ac.uk>
Date: Wed, 11 Jan 2023 16:46:01 +0000
Subject: [PATCH] change(docs): add FAQ for Windows installation
---
docs/source/INSTALL.md | 20 +++++++++++++++++---
1 file changed, 17 insertions(+), 3 deletions(-)
diff --git a/docs/source/INSTALL.md b/docs/source/INSTALL.md
index 24ff46c5..3633941f 100644
--- a/docs/source/INSTALL.md
+++ b/docs/source/INSTALL.md
@@ -40,19 +40,33 @@ Or using [pyenv](https://github.com/pyenv/pyenv) with pyenv-virtualenv:
### Pip version
Once you have created and activated your virtual environment, run:
-If you are analysing data locally:
+If you are not using an OMERO server setup:
$ pip install aliby
-If you are contacting an OMERO server:
+Otherwise, if you are contacting an OMERO server:
$ pip install aliby[network]
NOTE: Support for OMERO servers in GNU/Linux computers requires building ZeroC-Ice, thus it requires build tools. The versions for Windows and MacOS are provided as Python wheels and thus installation is faster.
+### FAQ
+- Installation fails during zeroc-ice compilation (Windows and MacOS).
+
+ - Windows
+ The simplest way to install it is using conda (or mamba). You can install the (OMERO) network components separately:
+
+ $ conda create -n aliby -c conda-forge python=3.8 omero-py
+ $ conda activate aliby
+ $ cd c:/Users/Public/Repos/aliby
+ $ \PATH\TO\POETRY\LOCATION\poetry install
+
+ - MacOS
+ Under work (See issue https://github.com/ome/omero-py/issues/317)
+
### Git version
-We use [ poetry ](https://python-poetry.org/docs/#installation) for dependency management.
+Install [ poetry ](https://python-poetry.org/docs/#installation) for dependency management.
In case you want to have local version:
--
GitLab