Skip to content

Commit

Permalink
Merge pull request #10 from WayScience/installation_instructions
Browse files Browse the repository at this point in the history
Installation Instructions
  • Loading branch information
MattsonCam authored Nov 22, 2024
2 parents 01fed0a + 03314b6 commit 1bd6eb2
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:<br>
`pip install git+https://github.com/WayScience/pairwise_compare.git`<br>
<br>
Note it is highly recommended to use a package manager such as Conda to install this tool.<br>
Once installed you can use subtools such as the `PairwiseCompareManager` with:<br>
`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.
Expand Down

0 comments on commit 1bd6eb2

Please sign in to comment.