Metadata-Version: 2.1
Name: scipion-em-miffi
Version: 1.0.2
Summary: Scipion plugin: a python wrapper to use miffi software within Scipion.
Home-page: https://github.com/scipion-em/scipion-em-miffi
Author: ando-lab
Author-email: scipion@cnb.csic.es
Project-URL: Bug Reports, https://github.com/scipion-em/scipion-em-miffi/issues
Project-URL: Source, https://github.com/scipion-em/scipion-em-miffi/
Keywords: scipion cryoem image processing scipion-3.0
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
License-File: LICENSE
Requires-Dist: scipion-pyworkflow
Requires-Dist: scipion-em

=================
Miffi plugin
=================

This plugin provides a wrapper for `miffi <https://github.com/ando-lab/miffi?tab=readme-ov-file>`_ software tools for automatic micrograph assessment.

**Miffi:** Cryo-EM micrograph filtering utilizing Fourier space information



Installation
-------------

You will need to use 3.0+ version of Scipion to be able to run these protocols. To install the plugin, you have two options:

a) Stable version

.. code-block::

   scipion installp -p scipion-em-miffi

b) Developer's version

   * download repository

    .. code-block::

        git clone -b devel https://github.com/scipion-em/scipion-em-miffi.git

   * install

    .. code-block::

       scipion installp -p /path/to/scipion-em-miffi --devel

miffi software will be installed automatically with the plugin but you can also use an existing installation by providing *MIFFI_ENV_ACTIVATION* (see below).
You also have to download training models separately (see below).

**Important:** you need to have conda (miniconda3 or anaconda3) pre-installed to use this program.

Configuration variables
-----------------------

*CONDA_ACTIVATION_CMD*: If undefined, it will rely on conda command being in the
PATH (not recommended), which can lead to execution problems mixing scipion
python with conda ones. One example of this could can be seen below but
depending on your conda version and shell you will need something different:
CONDA_ACTIVATION_CMD = eval "$(/extra/miniconda3/bin/conda shell.bash hook)"

*MIFFI_ENV_ACTIVATION* (default = conda activate miffi-1.0.0):
Command to activate the miffi environment.

*MIFFI_MODELS* (default = software/em/miffi-1.0.0/miffi-models)

Verifying
---------

To check the installation, simply run the following Scipion test:

``scipion test miffi.tests.test_protocols_miffi.TestMiffi``

Supported versions
------------------

1.0.0

Protocols
----------

* categorize micrographs

References
-----------

1. Da Xu, Nozomi Ando, Miffi: Improving the accuracy of CNN-based cryo-EM micrograph filtering with fine-tuning and Fourier space information, Journal of Structural Biology, Volume 216, Issue 2,
2024,108072,ISSN 1047-8477,https://doi.org/10.1016/j.jsb.2024.108072.
