https://github.com/unine-chyn/mmappickle

Python 3 library to store memory mappable objects into pickle-compatible files
https://github.com/unine-chyn/mmappickle

dictionary memory mmap python python-3 python-library python3

Last synced: about 1 year ago
JSON representation

Python 3 library to store memory mappable objects into pickle-compatible files

• Host: GitHub
• URL: https://github.com/unine-chyn/mmappickle
• Owner: UniNE-CHYN
• License: lgpl-3.0
• Created: 2017-03-30T06:36:12.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-06-18T13:15:49.000Z (almost 8 years ago)
• Last Synced: 2025-04-14T18:17:05.334Z (about 1 year ago)
• Topics: dictionary, memory, mmap, python, python-3, python-library, python3
• Language: Python
• Homepage: http://mmappickle.readthedocs.io
• Size: 85 KB
• Stars: 38
• Watchers: 3
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Memmap pickle

=============

This Python 3 module enables to store large structure in a python pickle, 

in such a way that the array can be memory-mapped instead of being copied in memory. This module is licensed under the LGPL3 license.

Currently, the container has to be a dictionnary (`mmappickle.dict`), which keys are strings of less than 256 bytes.

It supports any values, but it is only possible to memory-map numpy arrays and numpy masked arrays.

It also supports concurrent access (i.e. you can pass a `mmappickle.dict` as an argument which is called using the `multiprocessing` Python module).

Documentation

=============

Documentation is available at http://mmappickle.readthedocs.io/

Citation

========

> Fasnacht, (2018). **mmappickle: Python 3 module to store memory-mapped numpy array in pickle format** . *Journal of Open Source Software*, 3(26), 651, https://doi.org/10.21105/joss.00651

Contributing

============

Please post issues and pull requests on github. Alternatively, you can also send your patches by email.

The following tools are used to ensure good code quality:

Tool         | Status

------------ | -------------

travis-ci | [![Build Status](https://travis-ci.org/UniNE-CHYN/mmappickle.svg?branch=master)](https://travis-ci.org/UniNE-CHYN/mmappickle)

AppVeyor | [![Build status](https://ci.appveyor.com/api/projects/status/rb3b0s0u6k8vmxfx?svg=true)](https://ci.appveyor.com/project/lfasnacht/mmappickle)

Coveralls | [![Coverage Status](https://coveralls.io/repos/github/UniNE-CHYN/mmappickle/badge.svg?branch=master)](https://coveralls.io/github/UniNE-CHYN/mmappickle?branch=master)