diff --git a/README.md b/README.md index 823e4aece1fb404ceb4a8653d778bee6b2eda77d..bfb707d103267369917eff73adcc02a6391a46b8 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ # Wela + +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. + +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. + +## Installing + +Clone the gitlab repository and install with poetry. + +## Getting started + +There are example scripts in `wela/examples`. + +Use + +- `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. +