dmf-utils


Namedmf-utils JSON
Version 0.1.3 PyPI version JSON
download
home_pageNone
SummaryDMF's Python package providing reusable functionalities for neuroscience research.
upload_time2024-09-17 01:59:25
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseMIT
keywords neuroscience data analysis research python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            
<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.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "dmf-utils",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "neuroscience, data analysis, research, python",
    "author": null,
    "author_email": "Dynamics of Memory Formation Group <llfuentemilla@ub.edu>, Pablo Marcos-Manch\u00f3n <pmarcos@ub.edu>",
    "download_url": "https://files.pythonhosted.org/packages/4e/fd/0d3aa6645af4801004d0877c58e0a87ef16875e6656c8c335c14b83a7447/dmf_utils-0.1.3.tar.gz",
    "platform": null,
    "description": "\n<p align=\"center\">\n  <a href=\"https://github.com/memory-formation/dmf-utils\">\n    <picture>\n        <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/memory-formation/dmf-utils/main/docs/assets/dmf-utils-dark.svg\">\n        <img alt=\"dmf-utils\" src=\"https://raw.githubusercontent.com/memory-formation/dmf-utils/main/docs/assets/dmf-utils.svg\">\n    </picture>\n  </a>\n</p>\n\n-------\n\n[![PyPI version](https://badge.fury.io/py/dmf-utils.svg)](https://pypi.org/project/dmf-utils/)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dmf-utils)\n[![Documentation Status](https://readthedocs.org/projects/dmf-utils/badge/?version=latest)](https://dmf-utils.readthedocs.io/en/latest/?badge=latest)\n![Tests](https://github.com/memory-formation/dmf-utils/actions/workflows/tests.yml/badge.svg)\n[![Project Status: WIP \u2013 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)\n[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/memory-formation/dmf-utils/blob/main/LICENSE)\n\n\nDMF 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.\n\n## Quick Start\n\nThis 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.\n\nYou can install the core package with pip or other package managers by running:\n\n```bash\npip install dmf-utils\n```\n\nSee the [documentation](https://dmf-utils.readthedocs.io/) for more installation options and help, including how to use it in environments without internet access.\n\n## Modules\n\n* [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.\n* [Env](https://dmf-utils.readthedocs.io/en/latest/modules/env.html): Manage environment variables.\n* [IO (Input/Output)](https://dmf-utils.readthedocs.io/en/latest/modules/io.html): Load and save data from different formats, and manage compressed files.\n* [Models](https://dmf-utils.readthedocs.io/en/latest/modules/models.html): Utilities for PyTorch models.\n* [Video](https://dmf-utils.readthedocs.io/en/latest/modules/video.html): Utilities to work with video files.\n\n\nSee the [modules documentation](https://dmf-utils.readthedocs.io/en/latest/modules/index.html) for more information.\n\n## Documentation\n\nFor full documentation, visit [Read the Docs](https://dmf-utils.readthedocs.io/).\n\n## Contributing\n\nThis 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.\n\n## License\n\nDMF Utils is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "DMF's Python package providing reusable functionalities for neuroscience research.",
    "version": "0.1.3",
    "project_urls": {
        "repository": "https://github.com/memory-formation/dmf-utils"
    },
    "split_keywords": [
        "neuroscience",
        " data analysis",
        " research",
        " python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f329c6976d89d3904668ecdb5d9f587113f24c996929e85a1c605bbcd67c0ff4",
                "md5": "f20e7ab2e6ebf6cdad2719d32206211a",
                "sha256": "d4e79068f72d240ccc93dd37271c524b77062f2102cfa500c5c3e679b3256300"
            },
            "downloads": -1,
            "filename": "dmf_utils-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f20e7ab2e6ebf6cdad2719d32206211a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 51532,
            "upload_time": "2024-09-17T01:59:24",
            "upload_time_iso_8601": "2024-09-17T01:59:24.224945Z",
            "url": "https://files.pythonhosted.org/packages/f3/29/c6976d89d3904668ecdb5d9f587113f24c996929e85a1c605bbcd67c0ff4/dmf_utils-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4efd0d3aa6645af4801004d0877c58e0a87ef16875e6656c8c335c14b83a7447",
                "md5": "ed7a1ac4a0ae3f6001730c2f7f43b7ae",
                "sha256": "b13fd6ccae9ef413466c25079db61a6abc466ad1bb196fed960c5a3c89561ce0"
            },
            "downloads": -1,
            "filename": "dmf_utils-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "ed7a1ac4a0ae3f6001730c2f7f43b7ae",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 41437,
            "upload_time": "2024-09-17T01:59:25",
            "upload_time_iso_8601": "2024-09-17T01:59:25.727952Z",
            "url": "https://files.pythonhosted.org/packages/4e/fd/0d3aa6645af4801004d0877c58e0a87ef16875e6656c8c335c14b83a7447/dmf_utils-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-17 01:59:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "memory-formation",
    "github_project": "dmf-utils",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "dmf-utils"
}
None
Elapsed time: 4.15943s