Skip to content

memory-formation/dmf-utils

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dmf-utils


PyPI version PyPI - Python Version Documentation Status Tests Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. 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:

pip install dmf-utils

See the documentation for more installation options and help, including how to use it in environments without internet access.

Modules

  • Alerts: Get notified when a function finishes running and send messages or files to Slack and Telegram.
  • Env: Manage environment variables.
  • IO (Input/Output): Load and save data from different formats, and manage compressed files.
  • Models: Utilities for PyTorch models.
  • Video: Utilities to work with video files.

See the modules documentation for more information.

Documentation

For full documentation, visit Read the Docs.

Contributing

This package is maintained by Dynamics of Memory Formation (DMF) at the University of Barcelona. 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 file for more details.