frameMerge

Name	frameMerge JSON
Version	0.0.1 JSON
	download
home_page	None
Summary	Lightweight tool to merge crystallographic frames
upload_time	2025-11-07 20:13:37
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	None
keywords	crystallography data processing
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # frameMerge
`frameMerge` is a lightweight Python package for merging crystallographic detector frames within HDF5 files - supporting both parallel (multiprocessing) and sequential execution.

## Installation
You can pull from pypi with pip
```bash
[TODO]
```
Or you can clone the repo and install it locally:
```bash
git clone https://github.com/ryan-odea/frameMerge.git
cd frameMerge 
pip install .
```

## Usage
You can use frameMerge directly from the command line as:
```
frameMerge --file-name input.h5 \
           --output-file merged.h5 \
           --n-frames 5000 \
           --n-merged-frames 10 \
           --skip-pattern 1 2 \
           --data-location entry/data \
           --data-name data \
           --parallel
```
or through the Python API
```python
from frameMerge import merger

m = merger(
    file_name="input.h5",
    output_file="merged.h5",
    n_frames=5000,
    n_merged_frames=10,
    skip_pattern=[1, 2],
    data_location="entry/data",
    data_name="data"
)
m.process(parallel=True)
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "frameMerge",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Ryan ODea <ryan.odea@psi.ch>",
    "keywords": "crystallography, data processing",
    "author": null,
    "author_email": "Ryan ODea <ryan.odea@psi.ch>",
    "download_url": "https://files.pythonhosted.org/packages/ef/e1/4241628563df71a1da6b7b01eb123bf79b61701f5a7c7a7a3e5dad85770b/framemerge-0.0.1.tar.gz",
    "platform": null,
    "description": "# frameMerge\n`frameMerge` is a lightweight Python package for merging crystallographic detector frames within HDF5 files - supporting both parallel (multiprocessing) and sequential execution.\n\n## Installation\nYou can pull from pypi with pip\n```bash\n[TODO]\n```\nOr you can clone the repo and install it locally:\n```bash\ngit clone https://github.com/ryan-odea/frameMerge.git\ncd frameMerge \npip install .\n```\n\n## Usage\nYou can use frameMerge directly from the command line as:\n```\nframeMerge --file-name input.h5 \\\n           --output-file merged.h5 \\\n           --n-frames 5000 \\\n           --n-merged-frames 10 \\\n           --skip-pattern 1 2 \\\n           --data-location entry/data \\\n           --data-name data \\\n           --parallel\n```\nor through the Python API\n```python\nfrom frameMerge import merger\n\nm = merger(\n    file_name=\"input.h5\",\n    output_file=\"merged.h5\",\n    n_frames=5000,\n    n_merged_frames=10,\n    skip_pattern=[1, 2],\n    data_location=\"entry/data\",\n    data_name=\"data\"\n)\nm.process(parallel=True)\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Lightweight tool to merge crystallographic frames",
    "version": "0.0.1",
    "project_urls": {
        "Repository": "https://github.com/ryan-odea/frameMerge"
    },
    "split_keywords": [
        "crystallography",
        " data processing"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9f115c18262be33df5fb544bc5d35088c2404192993a4caf727838bf05c10819",
                "md5": "6e0d9700c8a299238f18c0d6ba47fb8f",
                "sha256": "74c5247177e840303d0ef83583b8bfbe9c4ce62a4b0e29a496cc9f5440fe200d"
            },
            "downloads": -1,
            "filename": "framemerge-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6e0d9700c8a299238f18c0d6ba47fb8f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7699,
            "upload_time": "2025-11-07T20:13:36",
            "upload_time_iso_8601": "2025-11-07T20:13:36.379702Z",
            "url": "https://files.pythonhosted.org/packages/9f/11/5c18262be33df5fb544bc5d35088c2404192993a4caf727838bf05c10819/framemerge-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "efe14241628563df71a1da6b7b01eb123bf79b61701f5a7c7a7a3e5dad85770b",
                "md5": "a3629f13af36a21beafe56d726f04f21",
                "sha256": "97583cf219cb9e643637e112771271a972a6f39dd30380d1f12015953d06fc2b"
            },
            "downloads": -1,
            "filename": "framemerge-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a3629f13af36a21beafe56d726f04f21",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 6396,
            "upload_time": "2025-11-07T20:13:37",
            "upload_time_iso_8601": "2025-11-07T20:13:37.371547Z",
            "url": "https://files.pythonhosted.org/packages/ef/e1/4241628563df71a1da6b7b01eb123bf79b61701f5a7c7a7a3e5dad85770b/framemerge-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-11-07 20:13:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ryan-odea",
    "github_project": "frameMerge",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "framemerge"
}