From 14a216fa514f2875ea2bff7e0e442c36a876cb3e Mon Sep 17 00:00:00 2001 From: Cameron Mattson Date: Thu, 21 Nov 2024 17:24:24 -0700 Subject: [PATCH 1/3] Added installation instructions in README. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index b115837..f7fc588 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 +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 when using this tool.
+Once installed you can tools 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. From 7e8d18c631768c04b0fa22a667a8922299b7fc5c Mon Sep 17 00:00:00 2001 From: Cameron Mattson Date: Thu, 21 Nov 2024 17:27:25 -0700 Subject: [PATCH 2/3] Increased clarity of README in installation subsection. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f7fc588..6e5dd19 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,8 @@ If you choose to interact with another component of the tool, then there will be 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 when using this tool.
-Once installed you can tools such as the `PairwiseCompareManager` with:
+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 From 03314b6dbf79b631cf39886a66916b95e3ad43fe Mon Sep 17 00:00:00 2001 From: Cameron Mattson Date: Fri, 22 Nov 2024 10:03:57 -0700 Subject: [PATCH 3/3] Included the available python versions. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e5dd19..5c06447 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Users should almost exclusively interact with the [PairwiseCompareManager](https If you choose to interact with another component of the tool, then there will be less input validation safeguards available. ## Installation -You can install this tool with:
+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.