Metadata-Version: 2.1
Name: quantifiles
Version: 0.1.1
Summary: Simple databrowser for quantify datasets.
Home-page: https://gitlab.com/dcrielaard/quantifiles
Author: Damien Crielaard
Author-email: damiencrielaard@gmail.com
License: BSD 2-Clause License
        
        Copyright (c) 2023, Damien Crielaard
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Platform: UNKNOWN
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: test
License-File: LICENSE

# Quantifiles

[![pipeline status](https://gitlab.com/dcrielaard/quantifiles/badges/main/pipeline.svg)](https://gitlab.com/dcrielaard/quantifiles/-/commits/main) 
[![PyPi](https://img.shields.io/pypi/v/quantifiles.svg)](https://pypi.org/pypi/quantifiles)
[![License](https://img.shields.io/badge/License-BSD_2--Clause-blue.svg)](https://opensource.org/licenses/BSD-2-Clause)
[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Welcome to Quantifiles, a PyQt5 application designed for viewing dataset files generated by [Quantify-core](https://gitlab.com/quantify-os/quantify-core/). With Quantifiles, you can easily browse and visualize the contents of your data directory, including the ability to view a plot of the data and browse snapshots.

## Installation

### Install from PyPI

```bash
pip install quantifiles
```

### Install from source

To install Quantifiles from source, first clone the repository:

```bash
git clone https://gitlab.com/dcrielaard/quantifiles.git
cd quantifiles
```

Then, install the application in a virtual environment using pip:
```bash
pip install -e .
```

### Install with pipenv

If you prefer to use pipenv for managing your virtual environment, you can install Quantifiles with the following command:

```bash
pipenv install git+https://gitlab.com/dcrielaard/quantifiles.git#egg=quantifiles
```

## Usage

You can launch the application by running the following command in your terminal:

```bash
quantifiles [--datadir DATADIR] [--liveplotting] [--loglevel LOGLEVEL]
```

If you don't specify the data directory, you can still access it by selecting File->Open in the application.

Alternatively, you can also use the executable file located in the Scripts folder, which will be generated upon installation.

To start the application from within Python, run:

```python
from quantifiles import quantifiles

quantifiles()  # This will start the application, optionally you can pass the data directory as an argument.
```

**Tip:** The plots can be copied to the clipboard by right-clicking on them.

## Contributing

We welcome contributions to Quantifiles! If you have an idea for a feature, or if you encounter a bug, please [open an issue](https://gitlab.com/dcrielaard/quantifiles/issues/new) or submit a pull request.

Feel free to dive in!

## License
This project is licensed under the terms of the BSD 2-Clause License. See the LICENSE file for more details.


