diff --git a/README.md b/README.md index b115837..5c06447 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,14 @@ Although, most of the development efforts can be found in the `src` folder. Users should almost exclusively interact with the [PairwiseCompareManager](https://github.com/WayScience/pairwise_compare/blob/main/src/comparison_tools/PairwiseCompareManager.py), however, there may be rare exceptions. If you choose to interact with another component of the tool, then there will be less input validation safeguards available. +## Installation +In Python 3.10 and 3.11 you can install this tool with:
+`pip install git+https://github.com/WayScience/pairwise_compare.git`
+
+Note it is highly recommended to use a package manager such as Conda to install this tool.
+Once installed you can use subtools such as the `PairwiseCompareManager` with:
+`from comparison_tools.PairwiseCompareManager import PairwiseCompareManager` + ## Data Formats When passing arguments to the `PairwiseCompareManager` you can specify the columns that remain the same in each group-to-group comparison, and the columns that will be different in these comparisons. These columns are parameterized by `_same_columns` and `_different_columns`, respectively.