Metadata-Version: 2.1
Name: pyvtools
Version: 1.2.0
Summary: Python tools
Author-email: Valeria Pais <valeriarpais@gmail.com>
License: MIT License
Project-URL: Repository, https://github.com/0xInfty/PyVTools.git
Project-URL: Homepage, https://github.com/0xInfty/PyVTools
Project-URL: Issues, https://github.com/0xInfty/PyVTools/issues
Keywords: deep learning,pytorch
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy<=1.26.4
Requires-Dist: matplotlib
Requires-Dist: opencv-python
Requires-Dist: scikit-image
Requires-Dist: pillow
Requires-Dist: scikit-learn
Requires-Dist: tifffile

# PyVTools

General custom tools to work in scientific research using Python

## Getting Started

### Installation

This package can easily be installed using `pip`:

```bash
pip install pyvtools
```

An alternative installation that partially uses Anaconda would involve...

1. First, install some Anaconda distribution, in case you do not have any:
   https://docs.anaconda.com/anaconda/install/
2. Then, create an Anaconda environment with Python 3.11.0
   ```bash
   conda create -n dev python=3.11.0
   ```
3. Activate the environment
   ```bash
   conda activate dev
   ```
3. Then, install all required packages by running the `install.sh` script:
   ```bash
   yes | . install.sh
   ```
   This will have executed...
   ```bash
   conda install python=3.11.0 numpy<=1.26.4 \
       matplotlib conda-forge::opencv scikit-image pillow scikit-learn conda-forge::tifffile
   pip install pyvtools
   ```
5. That's it! You're good to go :)

That second installation procedure is designed to be overly redundant, so please feel free to follow your own installation procedure.

### Requirements

Provided installation steps are only guaranteed to work in Ubuntu 24.04.

In case you are following another installation procedure, this repository requires...

- Python 3.11.0
- Numpy <= 1.26.4

## Additional information

### Main Author Contact

Valeria Pais - @vrpais - valeriarpais@gmail.com
