Metadata-Version: 2.1
Name: dmf-utils
Version: 0.1.2
Summary: DMF's Python package providing reusable functionalities for neuroscience research.
Author-email: Dynamics of Memory Formation Group <llfuentemilla@ub.edu>, Pablo Marcos-Manchón <pmarcos@ub.edu>
License: MIT
Project-URL: repository, https://github.com/memory-formation/dmf-utils
Keywords: neuroscience,data analysis,research,python
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: lazy-loader
Requires-Dist: typing-extensions; python_version == "3.7"
Requires-Dist: python-dotenv<0.22.0,>=0.21.0; python_version == "3.7"
Requires-Dist: python-dotenv>=1.0.1; python_version >= "3.8"
Provides-Extra: alerts
Requires-Dist: slack-sdk; extra == "alerts"
Requires-Dist: requests; extra == "alerts"
Provides-Extra: all
Requires-Dist: sphinx; extra == "all"
Requires-Dist: pydata-sphinx-theme; extra == "all"
Requires-Dist: slack-sdk; extra == "all"
Requires-Dist: requests; extra == "all"
Requires-Dist: numpy; extra == "all"
Requires-Dist: opencv-python; extra == "all"
Requires-Dist: pillow; extra == "all"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Provides-Extra: extra
Requires-Dist: pandas; extra == "extra"
Requires-Dist: h5py; extra == "extra"
Requires-Dist: torch; extra == "extra"
Requires-Dist: pyyaml; extra == "extra"
Requires-Dist: scipy; extra == "extra"
Requires-Dist: librosa; extra == "extra"
Requires-Dist: matplotlib; extra == "extra"
Requires-Dist: py7zr; extra == "extra"
Provides-Extra: video
Requires-Dist: numpy; extra == "video"
Requires-Dist: opencv-python; extra == "video"
Requires-Dist: pillow; extra == "video"


<p align="center">
  <a href="https://github.com/memory-formation/dmf-utils">
    <picture>
        <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/memory-formation/dmf-utils/main/docs/assets/dmf-utils-dark.svg">
        <img alt="dmf-utils" src="https://raw.githubusercontent.com/memory-formation/dmf-utils/main/docs/assets/dmf-utils.svg">
    </picture>
  </a>
</p>

-------

[![PyPI version](https://badge.fury.io/py/dmf-utils.svg)](https://pypi.org/project/dmf-utils/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dmf-utils)
[![Documentation Status](https://readthedocs.org/projects/dmf-utils/badge/?version=latest)](https://dmf-utils.readthedocs.io/en/latest/?badge=latest)
![Tests](https://github.com/memory-formation/dmf-utils/actions/workflows/tests.yml/badge.svg)
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/memory-formation/dmf-utils/blob/main/LICENSE)


DMF Utils is a Python package that provides a collection of utility functionalities to simplify common tasks in experiment and data analysis workflows. The package contains modules used by our group to facilitate tasks in neuroscience research.

## Quick Start

This package is designed in a modular way, with some functionalities included in this repository and others in separate packages that can be called from here. This allows for installing only the components needed for a specific project, aiming to maintain the broadest compatibility with different Python versions.

You can install the core package with pip or other package managers by running:

```bash
pip install dmf-utils
```

See the [documentation](https://dmf-utils.readthedocs.io/) for more installation options and help, including how to use it in environments without internet access.

## Modules

* [Alerts](https://dmf-utils.readthedocs.io/en/latest/modules/alerts.html): Get notified when a function finishes running and send messages or files to Slack and Telegram.
* [Env](https://dmf-utils.readthedocs.io/en/latest/modules/env.html): Manage environment variables.
* [IO (Input/Output)](https://dmf-utils.readthedocs.io/en/latest/modules/io.html): Load and save data from different formats, and manage compressed files.
* [Models](https://dmf-utils.readthedocs.io/en/latest/modules/models.html): Utilities for PyTorch models.
* [Video](https://dmf-utils.readthedocs.io/en/latest/modules/video.html): Utilities to work with video files.


See the [modules documentation](https://dmf-utils.readthedocs.io/en/latest/modules/index.html) for more information.

## Documentation

For full documentation, visit [Read the Docs](https://dmf-utils.readthedocs.io/).

## Contributing

This package is maintained by [Dynamics of Memory Formation (DMF)](https://brainvitge.org/groups/memory_formation/) at the [University of Barcelona](https://web.ub.edu/en/web/ub/). If you would like to contribute, please open an issue or a pull request.

## License

DMF Utils is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
