Metadata-Version: 2.4
Name: flitsr
Version: 3.0.0
Summary: An automatic fault finding/localization tool for multiple faults
Author-email: Dylan Callaghan <dcallaghan@acm.org>
License: MIT License
        
        Copyright (c) 2023 Dylan Callaghan
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/DCallaz/flitsr
Project-URL: Issues, https://github.com/DCallaz/flitsr/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Debuggers
Classifier: Intended Audience :: Developers
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: importlib_metadata; python_version < "3.10"
Requires-Dist: argcomplete
Requires-Dist: numpy
Requires-Dist: bitarray
Requires-Dist: scipy
Requires-Dist: deprecated
Requires-Dist: recordclass
Provides-Extra: plot
Requires-Dist: matplotlib; extra == "plot"
Dynamic: license-file

# FLITSR
A python implementation of the FLITSR fault localization tool for multiple
faults.

For the full documentation, see the [Read the Docs
page](https://flitsr.readthedocs.io), and for the source code, see the [GitHub
repository](https://github.com/DCallaz/flitsr).

## Setup
### Requirements
* `python3` (> `3.8`)
* `java` (optional; used for parallel techniques)
* `matplotlib` (optional; used for evaluation plotting)
### Installation
#### Quick install
To install FLITSR, simply install as a python package using the following
command:
```
pip install flitsr
```

For more detailed installation instructions, see [Installation
Instructions](https://flitsr.readthedocs.io/en/latest/install.html) in the
documentation.

## Basic usage
### Running FLITSR
To run the FLITSR algorithm and produce a suspiciousness ranking, simply use the
command:
```
flitsr <input>
```
where `<input>` is the directory containing the coverage files for GZoltar
input, or the file containing the coverage for TCM input. See the Input structure
section for more information on the types of input.

More advanced options and outputs are described in the
[documentation](https://flitsr.readthedocs.io/en/latest/base_tool.html).

### Running evaluation
To run the full evaluation on FLITSR, simply use the command:
```
run_all [-t [<extension>]/-g]
```
in the top level directory for the dataset. If the `-t` option is given (with an
optional file extension), then the TCM format is assumed, otherwise if the `-g`
option is given, Gzoltar format is assumed.

See the [documentation](https://flitsr.readthedocs.io/en/latest/eval_framework.html)
for more information.
