mcemtools


Namemcemtools JSON
Version 0.9.9 PyPI version JSON
download
home_pagehttps://github.com/arsadri/mcemtools
SummaryState of the art analysis tools for 4D STEM
upload_time2024-12-19 00:45:23
maintainerNone
docs_urlNone
authorAlireza Sadri
requires_python>=3.8
licenseMIT license
keywords mcemtools
VCS
bugtrack_url
requirements lognflow scikit-learn PyQt5 PySide6 napari torch torchvision torchaudio pypng h5py
Travis-CI
coveralls test coverage No coveralls.
            =========
mcemtools
=========


.. image:: https://img.shields.io/pypi/v/mcemtools.svg
        :target: https://pypi.python.org/pypi/mcemtools

.. image:: https://img.shields.io/travis/arsadri/mcemtools.svg
        :target: https://travis-ci.com/arsadri/mcemtools

.. image:: https://readthedocs.org/projects/mcemtools/badge/?version=latest
        :target: https://mcemtools.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status

Deep unsupervised analysis tools for Four-dimensional Scanning Transmission Electron Microscopy (4D-STEM) 

* Free software: MIT license
* Documentation: https://mcemtools.readthedocs.io.


Features
--------

* TODO

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.1.0 (2022-09-07)
------------------

* First release on PyPI.

0.2.0 (2023-07-11)
------------------

* Many functions used for 4D-STEM analysis have been added.
* OOP is avoided as much as possible.

0.3.0 (2023-07-11)
------------------

* Tests are increasing in number
* init includes import of mcemtools

0.4.0 (2023-07-11)
------------------

* Many small bugs are fixed

0.5.0 (2023-07-12)
------------------
* Added binning to transforms

0.6.0 (2023-07-14)
------------------
* More tests are added
* Names are consistant accross the package.

0.7.0 (2023-07-15)
------------------
* markimage bug is fixed

0.8.0 (2023-07-19)
------------------
* markimage bug is fixed really as US version of centre is center.
* napari based GUI is added to mcemtools.
* bianary files can be read too.

0.8.1 (2023-07-27)
------------------
* viewer_4D is a lot more concise and bug free.

0.8.2 (2023-07-27)
------------------
* by pressing i, you get shapes info, m shows the mask and F5 updates the mask.

0.8.3 (2023-07-28)
------------------
* critical bug was fixed in viewer_4D

0.8.4 (2023-07-28)
------------------
* critical bug was fixed in viewer_4D

0.8.5 (2023-08-03)
------------------
* bug fixed in image_by_windows

0.8.6 (2023-08-05)
------------------
* viewer_4D handles arrows to move the selected objects.

0.8.7 (2023-08-31)
------------------
* added load_raw and load_dm4.
* bug fixed in viewer_4D, moves a lot smoother than before.
* viewer_4D shows a single image when size of the mask is 1 pixel, rapidly.
* conv_4D added to analysis

0.8.8 (2023-09-04)
------------------
* critical bug fixed in bin_4D

0.8.9 (2023-09-20)
------------------
* bug removed from Normalize_4D
* bug removed from SymmetrySTEM
* tets added to locate atom and ...

0.8.10 (2023-09-12)
-------------------
* bug removed from SymmetrySTEM and mirror is added
* data_maker_4D can be updated
* remove_islands_by_size bug fixed

0.8.11 (2023-09-25)
-------------------
* Bug fixed in viewer_4D

0.9.0 (2023-10-13)
-------------------
* added denoise4net
* added clustering4net and feature_maker_4D

0.9.1 (2024-02-23)
-------------------
* added denoise4_tsvd
* faster bin_4D
* torch handler does not update the model if the loss is inf or nan

0.9.2 (2024-03-23)
-------------------
* annular mask can handle even sized image

0.9.2 (2024-05-02)
-------------------
* viewer_4D takes second mask to subtract

0.9.3 (2024-05-24)
-------------------
* viewer_4D takes second mask to subtract

0.9.4 (2024-06-01)
-------------------
* minimal requirenments and test scripts for denoising is added
* first denoising example added
* many bugs fixed for the denoiser
* More concerete example is added for geometric flow based denoising for the paper

0.9.5 (2024-11-08)
-------------------
* Annular mask fixed
* added supervised 2D denoiser
* renamed denoise4net to denoise4_unet

0.9.6 (2024-11-08)
-------------------
* denoiser needed a fix

0.9.7 (2024-11-15)
-------------------
* critical bug fixed in applying spatial incoherence

0.9.8 (2024-11-15)
-------------------
* Maybe the installer should not install napari stuff
* removed autoconvolution from symmstem

0.9.9 (2024-12-19)
-------------------
* CapsNet is complete

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/arsadri/mcemtools",
    "name": "mcemtools",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "mcemtools",
    "author": "Alireza Sadri",
    "author_email": "Alireza.Sadri@monash.edu",
    "download_url": "https://files.pythonhosted.org/packages/3a/5f/a685c318faa2f584d7f2ba2fd14d61d815f1baee92953febbcc6bce2e41e/mcemtools-0.9.9.tar.gz",
    "platform": null,
    "description": "=========\nmcemtools\n=========\n\n\n.. image:: https://img.shields.io/pypi/v/mcemtools.svg\n        :target: https://pypi.python.org/pypi/mcemtools\n\n.. image:: https://img.shields.io/travis/arsadri/mcemtools.svg\n        :target: https://travis-ci.com/arsadri/mcemtools\n\n.. image:: https://readthedocs.org/projects/mcemtools/badge/?version=latest\n        :target: https://mcemtools.readthedocs.io/en/latest/?version=latest\n        :alt: Documentation Status\n\nDeep unsupervised analysis tools for Four-dimensional Scanning Transmission Electron Microscopy (4D-STEM) \n\n* Free software: MIT license\n* Documentation: https://mcemtools.readthedocs.io.\n\n\nFeatures\n--------\n\n* TODO\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\n0.1.0 (2022-09-07)\n------------------\n\n* First release on PyPI.\n\n0.2.0 (2023-07-11)\n------------------\n\n* Many functions used for 4D-STEM analysis have been added.\n* OOP is avoided as much as possible.\n\n0.3.0 (2023-07-11)\n------------------\n\n* Tests are increasing in number\n* init includes import of mcemtools\n\n0.4.0 (2023-07-11)\n------------------\n\n* Many small bugs are fixed\n\n0.5.0 (2023-07-12)\n------------------\n* Added binning to transforms\n\n0.6.0 (2023-07-14)\n------------------\n* More tests are added\n* Names are consistant accross the package.\n\n0.7.0 (2023-07-15)\n------------------\n* markimage bug is fixed\n\n0.8.0 (2023-07-19)\n------------------\n* markimage bug is fixed really as US version of centre is center.\n* napari based GUI is added to mcemtools.\n* bianary files can be read too.\n\n0.8.1 (2023-07-27)\n------------------\n* viewer_4D is a lot more concise and bug free.\n\n0.8.2 (2023-07-27)\n------------------\n* by pressing i, you get shapes info, m shows the mask and F5 updates the mask.\n\n0.8.3 (2023-07-28)\n------------------\n* critical bug was fixed in viewer_4D\n\n0.8.4 (2023-07-28)\n------------------\n* critical bug was fixed in viewer_4D\n\n0.8.5 (2023-08-03)\n------------------\n* bug fixed in image_by_windows\n\n0.8.6 (2023-08-05)\n------------------\n* viewer_4D handles arrows to move the selected objects.\n\n0.8.7 (2023-08-31)\n------------------\n* added load_raw and load_dm4.\n* bug fixed in viewer_4D, moves a lot smoother than before.\n* viewer_4D shows a single image when size of the mask is 1 pixel, rapidly.\n* conv_4D added to analysis\n\n0.8.8 (2023-09-04)\n------------------\n* critical bug fixed in bin_4D\n\n0.8.9 (2023-09-20)\n------------------\n* bug removed from Normalize_4D\n* bug removed from SymmetrySTEM\n* tets added to locate atom and ...\n\n0.8.10 (2023-09-12)\n-------------------\n* bug removed from SymmetrySTEM and mirror is added\n* data_maker_4D can be updated\n* remove_islands_by_size bug fixed\n\n0.8.11 (2023-09-25)\n-------------------\n* Bug fixed in viewer_4D\n\n0.9.0 (2023-10-13)\n-------------------\n* added denoise4net\n* added clustering4net and feature_maker_4D\n\n0.9.1 (2024-02-23)\n-------------------\n* added denoise4_tsvd\n* faster bin_4D\n* torch handler does not update the model if the loss is inf or nan\n\n0.9.2 (2024-03-23)\n-------------------\n* annular mask can handle even sized image\n\n0.9.2 (2024-05-02)\n-------------------\n* viewer_4D takes second mask to subtract\n\n0.9.3 (2024-05-24)\n-------------------\n* viewer_4D takes second mask to subtract\n\n0.9.4 (2024-06-01)\n-------------------\n* minimal requirenments and test scripts for denoising is added\n* first denoising example added\n* many bugs fixed for the denoiser\n* More concerete example is added for geometric flow based denoising for the paper\n\n0.9.5 (2024-11-08)\n-------------------\n* Annular mask fixed\n* added supervised 2D denoiser\n* renamed denoise4net to denoise4_unet\n\n0.9.6 (2024-11-08)\n-------------------\n* denoiser needed a fix\n\n0.9.7 (2024-11-15)\n-------------------\n* critical bug fixed in applying spatial incoherence\n\n0.9.8 (2024-11-15)\n-------------------\n* Maybe the installer should not install napari stuff\n* removed autoconvolution from symmstem\n\n0.9.9 (2024-12-19)\n-------------------\n* CapsNet is complete\n",
    "bugtrack_url": null,
    "license": "MIT license",
    "summary": "State of the art analysis tools for 4D STEM",
    "version": "0.9.9",
    "project_urls": {
        "Homepage": "https://github.com/arsadri/mcemtools"
    },
    "split_keywords": [
        "mcemtools"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b3ee5ee67d457253b116afb67bb3070b6bb91233b95ae1506bde6e630d8d7553",
                "md5": "caba93d6073161c381d0cdb05e02d92f",
                "sha256": "9feefdd71a932ec605c3ff1d62e350b0da408877b385246d7fb991a28423e220"
            },
            "downloads": -1,
            "filename": "mcemtools-0.9.9-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "caba93d6073161c381d0cdb05e02d92f",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.8",
            "size": 73418,
            "upload_time": "2024-12-19T00:45:20",
            "upload_time_iso_8601": "2024-12-19T00:45:20.338895Z",
            "url": "https://files.pythonhosted.org/packages/b3/ee/5ee67d457253b116afb67bb3070b6bb91233b95ae1506bde6e630d8d7553/mcemtools-0.9.9-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3a5fa685c318faa2f584d7f2ba2fd14d61d815f1baee92953febbcc6bce2e41e",
                "md5": "2a8b570eb01503845c789be788c3ac4c",
                "sha256": "99dc7b5d8d63d16bdb8b8953904c23d8288c97f762240258a1e5e991bf6ce1c2"
            },
            "downloads": -1,
            "filename": "mcemtools-0.9.9.tar.gz",
            "has_sig": false,
            "md5_digest": "2a8b570eb01503845c789be788c3ac4c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 74550,
            "upload_time": "2024-12-19T00:45:23",
            "upload_time_iso_8601": "2024-12-19T00:45:23.097481Z",
            "url": "https://files.pythonhosted.org/packages/3a/5f/a685c318faa2f584d7f2ba2fd14d61d815f1baee92953febbcc6bce2e41e/mcemtools-0.9.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-19 00:45:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "arsadri",
    "github_project": "mcemtools",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "lognflow",
            "specs": []
        },
        {
            "name": "scikit-learn",
            "specs": []
        },
        {
            "name": "PyQt5",
            "specs": []
        },
        {
            "name": "PySide6",
            "specs": []
        },
        {
            "name": "napari",
            "specs": []
        },
        {
            "name": "torch",
            "specs": []
        },
        {
            "name": "torchvision",
            "specs": []
        },
        {
            "name": "torchaudio",
            "specs": []
        },
        {
            "name": "pypng",
            "specs": []
        },
        {
            "name": "h5py",
            "specs": []
        }
    ],
    "tox": true,
    "lcname": "mcemtools"
}
        
Elapsed time: 0.52541s