From c1eaabdc9b5057a83eb68fbdd9b2f6dd29f05a26 Mon Sep 17 00:00:00 2001 From: pswain <peter.swain@ed.ac.uk> Date: Tue, 23 Jan 2024 18:44:15 +0000 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index bfb707d..cebf66e 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,24 @@ # Wela -A package to analyse output from aliby. +A package to analyse output from `aliby`. -Wela uses the h5 files created by aliby to create a dataframe and save this dataframe as a text file. +`wela` uses the h5 files created by `aliby` to generate a dataframe and save this dataframe as a text file. -With Wela, you can use a Gaussian process to generate single-cell growth rates. +With `wela`, you can use a Gaussian process to generate single-cell growth rates. -Wela includes plotting routines for common tasks, such as kymographs and plotting single lineages for one ALCATRAS trap. +`wela` includes plotting routines for common tasks, such as kymographs and plotting single lineages for one ALCATRAS trap. ## Installing -Clone the gitlab repository and install with poetry. +Clone the gitlab repository and install with `poetry`. ## Getting started There are example scripts in `wela/examples`. -Use +Consult -- `create_tsv.py` to see how to generate a tsv file of the data -- `plot_kymograph.py` to see how to generate a kymograph -- `run_gr.py` to learn how to estimate single-cell growth rates. +- `create_tsv.py` to generate a tsv (tab separated value) file of the data +- `plot_kymograph.py` to generate a kymograph +- `run_gr.py` to estimate single-cell growth rates. -- GitLab