Skip to content

Installation Instructions #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MattsonCam merged 3 commits into from
Nov 22, 2024
Merged

Installation Instructions #10

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
14a216f
Added installation instructions in README.
Nov 22, 2024
7e8d18c
Increased clarity of README in installation subsection.
Nov 22, 2024
03314b6
Included the available python versions.
Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
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