From 13eb042dd5da265c3d7b4126ae82e27724cb39f4 Mon Sep 17 00:00:00 2001
From: pswain <peter.swain@ed.ac.uk>
Date: Tue, 7 May 2024 15:50:00 +0100
Subject: [PATCH] Update README.md
---
README.md | 131 +++++++++++++++++++-----------------------------------
1 file changed, 46 insertions(+), 85 deletions(-)
diff --git a/README.md b/README.md
index 2e8c40ad..2cac2b87 100644
--- a/README.md
+++ b/README.md
@@ -1,112 +1,73 @@
-# ALIBY (Analyser of Live-cell Imaging for Budding Yeast)
+# ALIBYlite (Analyser of Live-cell Imaging for Budding Yeast)
-[](https://aliby.readthedocs.io/en/latest)
-[](https://badge.fury.io/py/aliby)
-[](https://gitlab.com/aliby/aliby/-/pipelines)
-[](https://gitlab.com/aliby/aliby/-/commits/dev)
-[](https://gitlab.com/aliby/aliby/-/commits/dev)
+End-to-end processing of cell microscopy time-lapses. ALIBY automates segmentation, tracking, lineage predictions and post-processing.
-End-to-end processing of cell microscopy time-lapses. ALIBY automates segmentation, tracking, lineage predictions, post-processing and report production. It leverages the existing Python ecosystem and open-source scientific software available to produce seamless and standardised pipelines.
+## Installation
-## Quickstart Documentation
-Installation of [VS Studio](https://visualstudio.microsoft.com/downloads/#microsoft-visual-c-redistributable-for-visual-studio-2022) Native MacOS support for is under work, but you can use containers (e.g., Docker, Podman) in the meantime.
+We recommend installing both ALIBY and WELA.
-To analyse local data
- ```bash
-pip install aliby
- ```
- Add any of the optional flags `omero` and `utils` (e.g., `pip install aliby[omero, utils]`). `omero` provides tools to connect with an OMERO server and `utils` provides visualisation, user interface and additional deep learning tools.
-
-See our [installation instructions]( https://aliby.readthedocs.io/en/latest/INSTALL.html ) for more details.
-
-### CLI
+To begin you should install [miniconda](https://docs.anaconda.com/free/miniconda/index.html) and [poetry](https://python-poetry.org).
-If installed via poetry, you have access to a Command Line Interface (CLI)
- ```bash
-aliby-run --expt_id EXPT_PATH --distributed 4 --tps None
- ```
+Once poetry is installed, we suggest running
-And to run Omero servers, the basic arguments are shown:
- ```bash
- aliby-run --expt_id XXX --host SERVER.ADDRESS --user USER --password PASSWORD
+```bash
+poetry config virtualenvs.create false
```
-The output is a folder with the original logfiles and a set of hdf5 files, one with the results of each multidimensional inside.
-
-For more information, including available options, see the page on [running the analysis pipeline](https://aliby.readthedocs.io/en/latest/PIPELINE.html)
+so that only conda creates virtual environments.
-## Using specific components
+Then
-### Access raw data
+- Create and activate an alibylite virtual environment
-ALIBY's tooling can also be used as an interface to OMERO servers, for example, to fetch a brightfield channel.
- ```python
-from aliby.io.omero import Dataset, Image
-
-server_info= {
- "host": "host_address",
- "username": "user",
- "password": "xxxxxx"}
-expt_id = XXXX
-tps = [0, 1] # Subset of positions to get.
-
-with Dataset(expt_id, **server_info) as conn:
- image_ids = conn.get_images()
-
-#To get the first position
-with Image(list(image_ids.values())[0], **server_info) as image:
- dimg = image.data
- imgs = dimg[tps, image.metadata["channels"].index("Brightfield"), 2, ...].compute()
- # tps timepoints, Brightfield channel, z=2, all x,y
-```
+```bash
+conda create -n alibylite python=3.10
+conda activate alibylite
+ ```
-### Tiling the raw data
+- Git clone alibylite, change to the alibylite directory, and use poetry to install:
-A `Tiler` object performs trap registration. It may be built in different ways but the simplest one is using an image and a the default parameters set.
+```bash
+poetry install
+ ```
-```python
-from aliby.tile.tiler import Tiler, TilerParameters
-with Image(list(image_ids.values())[0], **server_info) as image:
- tiler = Tiler.from_image(image, TilerParameters.default())
- tiler.run_tp(0)
-```
+- Git clone wela, change to the wela directory, and use poetry to install:
-The initialisation should take a few seconds, as it needs to align the images
-in time.
+```bash
+poetry install
+ ```
-It fetches the metadata from the Image object, and uses the TilerParameters values (all Processes in aliby depend on an associated Parameters class, which is in essence a dictionary turned into a class.)
+- Use pip to install your usual Python working environment. For example:
-#### Get a timelapse for a given tile (remote connection)
-```python
-fpath = "h5/location"
+```bash
+pip install ipython seaborn
+ ```
-tile_id = 9
-trange = range(0, 10)
-ncols = 8
+- Install omero-py.
-riv = remoteImageViewer(fpath)
-trap_tps = [riv.tiler.get_tiles_timepoint(tile_id, t) for t in trange]
+For a Mac, use:
-# You can also access labelled traps
-m_ts = riv.get_labelled_trap(tile_id=0, tps=[0])
+```bash
+conda install -c conda-forge zeroc-ice==3.6.5
+conda install omero-py
+ ```
-# And plot them directly
-riv.plot_labelled_trap(trap_id=0, channels=[0, 1, 2, 3], trange=range(10))
-```
+ For everything else, use:
-Depending on the network speed can take several seconds at the moment.
-For a speed-up: take fewer z-positions if you can.
+ ```bash
+poetry --all-extras
+ ```
-#### Get the tiles for a given time point
-Alternatively, if you want to get all the traps at a given timepoint:
+- You may have an issue with Matlablib crashing.
+Use conda to install a different version:
-```python
-timepoint = (4,6)
-tiler.get_tiles_timepoint(timepoint, channels=None,
- z=[0,1,2,3,4])
-```
+```bash
+conda search -f matplotlib
+ ```
+ and, for example,
-### Contributing
-See [CONTRIBUTING](https://aliby.readthedocs.io/en/latest/INSTALL.html) on how to help out or get involved.
+ ```bash
+conda install matplotlib=3.8.0
+ ```
--
GitLab