Metadata-Version: 2.2
Name: topsis_102203992
Version: 1.1
Summary: Package for Topsis Score Calculation
Author: Ishita Garg
Description-Content-Type: text/markdown
License-File: license.txt
Requires-Dist: pandas>=1.0.0
Requires-Dist: numpy>=1.18.0
Dynamic: author
Dynamic: description
Dynamic: description-content-type
Dynamic: requires-dist
Dynamic: summary


TOPSIS (Technique for Order of Preference by Similarity to Ideal Solution) is a decision-making method used to rank options based on their closeness to the best possible choice. It works by comparing each option to an ideal solution, which has the best values for all criteria, and an anti-ideal solution, which has the worst values. The method calculates scores based on how close each option is to the ideal and how far it is from the worst. Simple and efficient, TOPSIS is often used in business, engineering, and management to make decisions when multiple factors need to be considered.

### How it does it work?

Consider a scenario where you're evaluating different smartphone models based on attributes like price, storage capacity, camera performance, and design. Instead of relying on subjective judgment, TOPSIS helps by standardizing the data, assigning weights to each criterion (for instance, giving more importance to camera performance than design), and measuring how far each model is from an ideal solution. The model closest to the "ideal case" ranks the highest.

### Necessities

To get started, ensure you have the following:

- **Python:** Version 3.7 or higher (preferably).
- **Pandas:** For data handling and manipulation.
- **NumPy:** For numerical calculations.

To run the dependecies, run:
```bash
pip install pandas
pip install numpy 
```
### How to run the script?

#### Command-Line Execution
Here is the command you will use to run the script:
```bash
topsis <inputFileName> <Weights> <Impacts> <resultFileName>
```

Where:
inputFileName is your CSV file that holds the data. It should have one column for alternatives and the rest for decision-making criteria (e.g., price, storage, camera).
Weights is a comma-separated string that specifies the importance (weight) of each criterion.
Impacts is another comma-separated string, indicating whether a criterion is beneficial (+) or non-beneficial (-).
resultFileName is where you want to save the output, containing the scores and ranks.

#### Example
Let us say we have a CSV file named input_data.csv and we want to weigh the features as 20%, 30%, 30%, and 20%, respectively, with the first three being beneficial and the last one (Looks) being non-beneficial.

Run:

```bash
topsis input_data.csv "0.2,0.3,0.3,0.2" "+,+,+,-" result.csv
```

This command will process the data, calculate the scores, and save the results in a file called result.csv.


### Input Data

| Model | Price | Storage | Camera | Looks |
|-------|-------|---------|--------|-------|
| M1    | 250   | 16      | 12     | 5     |
| M2    | 200   | 16      | 8      | 3     |
| M3    | 300   | 32      | 16     | 4     |
| M4    | 275   | 32      | 8      | 4     |
| M5    | 225   | 16      | 16     | 2     |

Here, each row represents a different alternative (e.g., smartphone model) and each column represents a decision-making criterion.

### Output Format

After running the decision-making script, the output includes the calculated *Score* and *Rank* for each model:

| Model | Price | Storage | Camera | Looks | Score   | Rank |
|-------|-------|---------|--------|-------|---------|------|
| M1    | 250   | 16      | 12     | 5     | 0.4459  | 4    |
| M2    | 200   | 16      | 8      | 3     | 0.3700  | 5    |
| M3    | 300   | 32      | 16     | 4     | 0.6299  | 1    |
| M4    | 275   | 32      | 8      | 4     | 0.4936  | 2    |
| M5    | 225   | 16      | 16     | 2     | 0.4758  | 3    |

### Explanation

- *Score*: The score is calculated based on a weighted evaluation of the decision-making criteria.
- *Rank*: Models are ranked based on their scores, with 1 being the highest rank.

### License:

This project is licensed under the MIT License. Feel free to use, modify, or contribute!
