Differences

This shows you the differences between two versions of the page.

--- gpu_isac [2020/07/27 12:39]
fschoenfeld
+++ gpu_isac [2020/09/23 15:02]
fschoenfeld
@@ Line 3: / Line 3: @@
 ===== Overview =====
-**ISAC** (Iterative Stable Alignment and Clustering) is a 2D classification algorithm to sort cryo-EM particles into classes depicting the same view of a target protein. It is based around iterations of
+**ISAC** (//Iterative Stable Alignment and Clustering//) is a **2D classification algorithm**. It sorts a given stack of cryo-EM particles into different classes that share the same view of a target protein. ISAC is based around iterations of alternating equal size k-means clustering and repeated 2D alignment routines.
-alternating equal size k-means clustering and repeated 2D alignment routines.
 <note>
@@ Line 11: / Line 10: @@
 </note>
-**ISAC2** is an improved version of ISAC, and the default tool to produce 2D class averages in the **[[http://sphire.mpg.de/wiki/doku.php?id=downloads:sphire_1_3|SPHIRE]]** ([[https://github.com/cryoem/eman2|git]]) software package and the **[[https://github.com/MPI-Dortmund/transphire|TranSPHIRE]]** automated pipeline for processing cryo-EM data. ISAC2 is a CPU-only implementation that is usually run on a computer cluster.
+===== ISAC versions =====
-**GPU ISAC** is designed to run ISAC2 on a single workstation by outsourcing its computationally expensive calculations to any available GPUs.
+  * **ISAC** is the initial version as described in the original paper. At this point this implementation is obsolete and has been replaced by ISAC2 and GPU ISAC (see below).
-<note important>
+  * **ISAC2** is an improved version of ISAC and used by default to produce 2D class averages in the **[[http://sphire.mpg.de/wiki/doku.php?id=downloads:sphire_1_3|SPHIRE]]** ([[https://github.com/cryoem/eman2|git]]) software package and the **[[https://github.com/MPI-Dortmund/transphire|TranSPHIRE]]** automated pipeline for processing cryo-EM data. ISAC2 is a CPU-only implementation and was developed to run on a computer cluster.
-**Beta version:** The currently available version of GPU ISAC is a beta version. A significantly improved and significantly faster version is being tested right now and will be released shortly.
-</note>
+  * **GPU ISAC** was developed to run ISAC2 on a single workstation by outsourcing its computationally expensive bottleneck calculations to any available GPUs, while simultaneously keeping its MPI-based CPU parallelization otherwise intact. GPU ISAC is provided as an add-on to SPHIRE that can be installed manually (see below).
 ===== Download & Installation =====
 <note important>
-  * **CUDA required:** The following installation instructions assume that CUDA is already installed on your system.
+**Before you start**, please note the following **system requirements**
-  * **SPHIRE required:** In order to use GPU ISAC, SPHIRE needs to be installed first and the following instructions assume that this is the case. You can find the SPHIRE download and installation instructions [[http://sphire.mpg.de/wiki/doku.php?id=downloads:sphire_1_3#download|here]].
+----
-//**Note:** To confirm a working version of SPHIRE 1.3 (or later), use //''which sphire''// in your terminal. It should return to you the path to your SPHIRE installation.//
+  * **CUDA:** These installation instructions assume that CUDA is already installed on your system. You can confirm this by running ''nvcc <nowiki>--</nowiki>version'' in your terminal; the resulting output should list the version of your installed CUDA compilation tools.
+  * **SPHIRE:** In order to use GPU ISAC, SPHIRE needs to be installed. You can find the SPHIRE download and installation instructions [[http://sphire.mpg.de/wiki/doku.php?id=downloads:sphire_1_3#download|here]]. You can confirm a working SPHIRE version by running ''which sphire'' in your terminal; the resulting output should give you the path to your SPHIRE installation (the path should indicate a version number of 1.3 or higher).
 </note>
+----
 === Download ===
-  * The GPU ISAC beta version is currently distributed as a .tar file that can be found {{:gpu_isac:gpu_isac_beta_chimera_.tar|here}}.
+  * GPU ISAC is currently developed as a manually installed add-on for SPHIRE and distributed as a .zip file that can be found here: {{:gpu_isac:gpu_isac_2.3.2.zip|GPU ISAC (v2.3.2) download link}}.
-  * A printout of the installation notes below can be found {{:gpu_isac:gpu_isac_installation_notes.pdf|here}}.
+----
 === Installation ===
+Before you start, make sure your SPHIRE environment is activated.
+<hidden How to activate your SPHIRE environment:>
+  * During the SPHIRE installation, an Anaconda environment for SPHIRE was created. You can list your available Anaconda environments using: <code>conda env list</code>
+  * Look for your SPHIRE environment and activate it using either: <code>conda activate NAME_OF_YOUR_ENVIRONMENT</code> or <code>source activate NAME_OF_YOUR_ENVIRONMENT</code> It will depend on your system and Anaconda installation which one of these you will have to use.
+</hidden>
+\\
+GPU ISAC comes with a handy installation script that can be used as follows:
   - **Extract the archive** to your chosen GPU ISAC installation folder.
   - **Open a terminal** and navigate to your installation folder.
-  - **Untar the archive**: <code>tar -xf GPU_ISAC_CHIMERA.tar</code>
+  - **Run the installation script**: <code>./install.sh</code>
-  - **Check CUDA path variables** using:
-    - <code>echo $PATH</code> Confirm your ''PATH'' variable contains the path to your **cuda/bin** folder.
-    - <code>echo $LD_LIBRARY_PATH</code> Confirm your ''LD_LIBRARY_PATH'' variable contain the path to your **cuda/lib64** folder.
-    - If the path variables do **not** contain these path variables, you can add them like so: <code>export PATH=/path/to/cuda/bin:${PATH}
-export LD_LIBRARY_PATH=/path/to/cuda/lib64:${LD_LIBRARY_PATH}</code> Where ''path/to/cuda/bin'' and ''path/to/cuda/lib64'' need to be replaced with the real paths to the respective folders. If you do not know where to find them, by default they should be located in ''/usr/local/cuda''.
-  - **Compile the GPU ISAC C++/CUDA library:**
-    - <code>cd vChimera/cuda</code>//**Note:** This assumes you did not change directories after unpacking the .tar archive.//
-    - <code>nvcc gpu_aln_common.cu gpu_aln_noref.cu -o gpu_aln_pack.so -shared -Xcompiler -fPIC -lcufft -std=c++11</code>
-  - **Adjust sparx libraries** to work with the C++/CUDA library we just compiled:
-    - <code>cd ../eman2/sparx/libpy</code>
-    - <code>sed -i.bkp "s|/home/schoenf/work/code/cuISAC/cuda|$(realpath ../../../cuda)|g" applications.py</code>
-    - <code>sed -i.bkp2 's|statistics.sum_oe( data, "a", CTF, EMData(), myid=myid|statistics.sum_oe( data, "a", CTF, EMData()|g' applications.py</code>
-  - **Set the correct libraries and environment:**
-    - <code>cd ../bin</code> //**Note:** We are now in the **/eman2/sparx/bin** folder of your GPU ISAC installation folder.//
-    - <code>ln -rs ../libpy/* .</code> //**Note:** Don't forget the dot at the end!//
-    - <code>sed -i.bkp "s|/home/schoenf/applications/sphire/v1.1/envs/sphire_1.3/bin|$(dirname $(which sphire))|g" sxisac2_gpu.py</code>
-    - <code>sed -i.bkp2 "s/^\(.*options, args.*\)$/\1\n    os.environ['CUDA_VISIBLE_DEVICES'] = options.gpu_devices\n    options.gpu_devices = ','.join(map(str, range(len(options.gpu_devices.split(',')))))/g" sxisac2_gpu.py</code>
-  - **Bugfix for the Chimera beta:**
-    - <code>sed -i.bkp3 "s/output_text = \"\n/output_text = \"/g" sxisac2_gpu.py</code>
+All done!
-===== Usage =====
+===== Running GPU ISAC =====
 An example call to use GPU ISAC looks as follows:
 <code>
-mpirun -np 6 /path/to/sxisac2_gpu.py bdb:path/to/stack out_dir --CTF -–radius=160 --target_radius=29 --target_nx=76 --img_per_grp=100 --minimum_grp_size=60 --thld_err=0.7 --center_method=0 --gpu_devices=0,1
+mpirun python /path/to/sxisac2_gpu.py bdb:path/to/stack path/to/output --CTF -–radius=160 --img_per_grp=100 --minimum_grp_size=60 --gpu_devices=0,1
 </code>
-More readable:
+Using the following mix of both mandatory and optional parameters (see below to learn which is which):
 <code>
-mpirun -np 6 /path/to/sxisac2_gpu.py
+mpirun python /path/to/sxisac2_gpu.py
-bdb:path/to/stack out_dir
+bdb:path/to/stack
+path/to/output
 --CTF
 -–radius=160
---target_radius=29
---target_nx=76
 --img_per_grp=100
 --minimum_grp_size=60
---thld_err=0.7
---center_method=0
 --gpu_devices=0,1
 </code>
@@ Line 86: / Line 77: @@
 **[ ! ] - Mandatory** parameters in the GPU ISAC call:
-  * Replace ''/path/to/sxisac2_gpu.py'' with the path to your **sxisac2_gpu.py** file.
+  * ''mpirun'' is not a GPU ISAC parameter, but is required to launch GPU ISAC using MPI parallelization (GPU ISAC uses MPI to parallelize CPU computations and MPI/CUDA to distribute and parallelize GPU computations).
-  * Replace ''path/to/stack'' with the path to your **input .bdb stack**. If you are using an **.hdf** stack, you need to remove the ''bdb:'' prefix.
+  * ''/path/to/sxisac2_gpu.py'' is the path to your **sxisac2_gpu.py** file. If you followed these instructions it should be ''your/installation/path/gpu_isac_2.2/bin/sxisac2_gpu.py''.
-  * Replace ''out_dir'' with the path to your preferred **output directory**.
+  * ''path/to/stack'' is the path to your **input .bdb stack**. If you prefer to use an **.hdf** stack, simply remove the ''bdb:'' prefix.
-  * Adjust the number in ''<nowiki>--</nowiki>radius=160'' to the **radius of your particle** (in pixels).
+  * ''path/to/output'' is the path to your preferred **output directory**.
+  * ''<nowiki>--</nowiki>radius=160'' is the **radius of your target particle** (in pixels) and has to be set accordingly.
+  * ''<nowiki>--</nowiki>gpu_devices'' tells GPU ISAC **what GPUs to use** by specifying their system id values.
-**[?] - Optional** parameters in the GPU ISAC call:
+<hidden What GPUs do I have and what are their system id values?>
+You can use ''nvidia-smi'' in your terminal to see what GPUs are available on your machine. This also lists their id values and sorts all entries by [[https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#compute-capabilities|CUDA compute capability]], where your most powerful GPU has id value 0 and your least powerful GPU has the highest id value:
-  * In ''mpirun –np 6'' the number can be set to the number of your **CPU processors** (e.g., if you have a quad core CPU, you would use 4 here).
+{{ :gpu_isac:gpu_isac_nvidia-smi.png |}}
-  * Using ''<nowiki>--</nowiki>gpu_devices'' you can set **what GPUs to use**. This example uses two GPUs with id values 0 and 1, respectively. You can check the id values of your available GPUs by executing ''nvidia-smi'' in your terminal (GPUs are sorted by capability, with 0 being your strongest GPU).
-  * You can also use ''<nowiki>--</nowiki>img_per_grp'' to limit the **maximum size of individual classes**. Empirically, a class size of 100-200 (30-50 for negative stain) particles has been proven successful when dealing with around 100,000 particles.
+Above: Example output of ''nvidia-smi''. GPU system id values and GPU names marked in red. Among other things, this also lists your current driver version, marked in turquoise.
-  * Similarly, you can also use ''<nowiki>--</nowiki>minimum_grp_size'' to limit the **minimum size of individual classes**. In general, this value should be around 50-60% of your maximum class size.
+</hidden>
+\\
+**[?] - Optional** parameters recommended to be used when running GPU ISAC:
+  * Use the ''<nowiki>--</nowiki>CTF'' flag to **apply phase flipping** to your particles.
+  * Use ''<nowiki>--</nowiki>img_per_grp'' to limit the **maximum size of individual classes**. Empirically, a class size of 100-200 (30-50 for negative stain) particles has been proven successful when dealing with around 100,000 particles. (This may differ for your data set and you can use GPU ISAC to find out; see below.)
+  * Use ''<nowiki>--</nowiki>minimum_grp_size'' to limit the **minimum size of individual classes**. In general, this value should be around 50-60% of your maximum class size.
 <note>
-  * The full list of **ISAC2 parameters** can be found [[http://sphire.mpg.de/wiki/doku.php?id=pipeline:isac:sxisac2|here]].
+  * An up to date list of **all GPU ISAC parameters** can always be printed by using the ''-h'' parameter (in this case you do not need to specify any other parameters): <code>mpirun python /path/to/sxisac2_gpu.py -h</code> or simply <code>python /path/to/sxisac2_gpu.py -h</code>
+  * The online documentation of **ISAC2 parameters** can be found [[http://sphire.mpg.de/wiki/doku.php?id=pipeline:isac:sxisac2|here]].
   * **Additional utilities** that are helpful when using any version of ISAC can be found [[http://sphire.mpg.de/wiki/doku.php?id=pipeline:isac:start|here]].
@@ Line 105: / Line 107: @@
   * More information about **using ISAC for 2D classification** can also be found in the ISAC chapter of the official [[ftp://ftp.gwdg.de/pub/misc/sphire/sphire_1_3_tutorial/sphire_1_3.pdf|SPHIRE tutorial]] (link to .pdf file).
 </note>
+===== Examples =====
+**EXAMPLE 01: Test run**
+This example is a test run that can be used to confirm GPU ISAC was installed successfully. It is a small stack that contains 64 artificial faces and is already included in the GPU ISAC installation package. You can process it using GPU ISAC as follows:
+  - In your terminal, navigate to your GPU ISAC installation folder:<code>cd /gpu/isac/installation/folder</code>
+  - Run GPU ISAC:<code>mpirun python bin/sxisac2_gpu.py 'bdb:examples/isac_dummy_data_64#faces' 'isac_out_test/' --radius=32 --img_per_grp=8 --minimum_grp_size=4 --gpu_devices=0</code>
+Note that we don't care about the quality of any produced averages here; this test is used to make sure there are no runtime issues before a more time consuming run is executed.
+----
+**EXAMPLE 02: TcdA1 toxin data**
+This example uses the [[https://ftp.gwdg.de/pub/misc/sphire/test_dataset/sphire_testdata_movies.tar|SPHIRE tutorial data set]] (link to .tar file) described in the [[ftp://ftp.gwdg.de/pub/misc/sphire/sphire_1_3_tutorial/sphire_1_3.pdf|SPHIRE tutorial]] (link to .pdf file). The data contains about 10,000 particles from 112 micrographs and was originally published here [[https://www.nature.com/articles/nature11987|(Gatsogiannis et al, 2013)]].
+After downloading the data you'll notice that the extracted folder contains a multitude of subfolders. For the purposes of this example we are only interested in the ''Particles/'' folder that stores the original data as a .bdb file.
+You can process this stack using GPU ISAC as follows:
+  - In your terminal, navigate to your GPU ISAC installation folder:<code>cd /gpu/isac/installation/folder</code>
+  - Run GPU ISAC:<code>mpirun python bin/sxisac2_gpu.py 'bdb:/your/path/to/Particles/#stack' 'isac_out_TcdA1' --CTF --radius=145 --img_per_grp=100 --minimum_grp_size=60 --gpu_devices=0</code>
+      * Replace ''/your/path/to/Particles/'' with the path to the ''Particles/'' directory you just downloaded.
+      * Optional: Replace ''<nowiki>--</nowiki>gpu_devices=0'' with ''<nowiki>--</nowiki>gpu_devices=0,1'' if you have two GPUs available (and so on).
+The final averages can then be found in ''isac_out_TcdA1/ordered_class_averages.hdf''. You can look at them using ''e2display.py'' (or any other displaying program of your choice) and should see averages like these:
+{{:gpu_isac:gpu_isac_class_averages.png|}}
+Above: 95 class averages produced when processing the above data set using GPU ISAC. The particle stack contains 11,003 particles and the averages were computed within 6 minutes (Intel i9-7020X CPU and 2x GeForce GTX 1080 GPUs).
+===== Usage =====
+Next to producing high quality 2D class averages, GPU ISAC is also an excellent tool to screen your data which allows you to:
+  * Quickly generate **2D class averages**.
+  * Quickly identify **suitable parameters** for your data set.
+  * Quickly gauge the **quality of your data** set before spending time on more costly processing steps.
+<hidden Well, "suitable parameters" sounds great! How do I get those?>
+Clustering cryo-EM data is a difficult problem that involves many different parameters and often it is unclear how these impact the resulting 2D class averages. In GPU ISAC the most relevant parameters to fiddle with are:
+  * **Class size:** The class (or cluster) size ''<nowiki>--</nowiki>img_per_grp'' in ISAC determines how many particles are taken together in order to construct a new 2D class average. High values will mean cleaner averages, but might also lump together particles that should be sorted into different classes. If you are using GPU ISAC to screen a set of 20,000 to 40,000 particles, then '100' particles per class are a good starting value. Further, the //minimun// size of each class ''<nowiki>--</nowiki>minimum_grp_size'' should be around 60% of set class size.
+  * **Threshold error:** The ''<nowiki>--</nowiki>thld_err'' parameter determines how similar subsequently produced averages have to be in order to be considered stable enough. A value of ''0.7'' is very stringent, while ''1.4'' is less so, and you should not need a higher value than ''2.4''.
+Since GPU ISAC processes small stacks of about 10,000 to 20,000 particles fairly quickly, you can try several runs with different values for ''<nowiki>--</nowiki>img_per_group'' and ''<nowiki>--</nowiki>thld_err'' to see which combination gives you the best results.
+Once you are happy with the results, you can use these parameters for a full-sized run of (GPU) ISAC. Good luck! :)
+</hidden>
+\\
+===== GPU ISAC output files =====
+GPU ISAC produces a multitude of output files that can be used to analyze the success of running the program, even while it is still ongoing. These include the following:
+  * **Main iteration folders:** As GPU ISAC is running, it performs multiple "main iterations" and "generations" that are stored within the output folder structure. New class averages are produced during every iteration / generation and can be looked at during runtime without having to wait for the overall process to conclude. This can help to **quickly gauge the quality of a data set**. Check ''path/to/output/mainXXX/generationYYY'' for the ''.hdf'' files to that contain any newly produced class averages.
+  * In both the main iteration folders and the base output folder you will find ''processed_images.txt'' files. These contain the indices of all processed particles and can be used to determine how many particles GPU ISAC did account for during classification.
+  * **The final averages** are stored in ''path/to/output/ordered_class_averages.hdf''.
+===== Release notes =====
+**GPU ISAC limitations**
+  * The current develpoment goal of GPU ISAC is to run as fast as possible on a single machine. Because of this priority, **GPU ISAC does not yet run on multiple nodes**. This is planned to change as soon as the currently known bottlenecks have all been converted to run on the available GPUs.
+------
+**Known issues**
+  * In some cases **when using CUDA version 11, GPU ISAC receives a kill signal interrupt**. We're investigating the issue but recommend to use a lower version (confirmed working when using CUDA 9 and 10) until it is resolved. You can use ''nvcc --version'' in your terminal to see the CUDA version you are using.
+------
+**GPU ISAC v2.3.1 & v2.3.2 (hotfix releases)**
+  * Changed data handling, which results in a massive reduction in overall memory usage and an increased pre-alignment performance.
+  * Fixed use of ''-h'' parameter to display the help.
+  * Fixed error in the pre-alignment progress bar that made it seem as if it did not run to completion.
+  * Minimum class size is now automatically set to 60% of the full class size, if no minimum class size was specified by the user.
+**GPU ISAC v2.3**
+  * Updated GPU ISAC install package for version 2.3.
+  * Fixed multiple issues occurring when handling larger data sets (200k and upwards).
+  * Added memory checks to the output to document GPU ISAC memory use.
+  * Batched input read, part I: Input is now read in batches with pre-processing already applied during reading. This means that we can now deal with data sets that do not fit into system RAM (as long as the compressed data does).
+  * Batched input read, part II: Input reading and processing is spread across all MPI processes, while actual processing (pre-alignment) is spread only across GPU processes. This ensures data is processed using all CPU & GPU resources available to the used machine.
+  * Multiple bug fixes for increased stability and functionality.
+  * Cleanup of old code for increased readability and maintainability.
+**GPU ISAC v2.2**
+  * Created an easy installation package for GPU ISAC including a quick test to confirm a successful installation.
+  * Added more sanity checks to catch invalid parameter combinations and abort the run immediately.
+  * Updated the transformation stack in GPU alignment functions for higher quality averages.
+  * Multiple bug fixes for increased stability and functionality.
+**GPU ISAC "Chimera"**
+  * Initially released beta version of GPU ISAC.

User Tools

Site Tools

Differences

Page Tools