User Tools

Site Tools


downloads:cryolo_1

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
downloads:cryolo_1 [2020/02/07 13:50]
twagner [Installation]
downloads:cryolo_1 [2021/02/19 09:43]
twagner
Line 1: Line 1:
-{{ :downloads:cryolo_logo.jpg?600 |}} +{{  :downloads:cryolo_logo.jpg?600  |Logo}}<note warning>
-====== License ======+
  
-  * **Author:** Thorsten Wagner +**DOCUMENTATION OUTDATED**
-  * **License:** [[:cryolo_license|EULA]] +
-  * **Last Update:** 2018-06-20+
  
-If you are interested in using crYOLO in a commercial context please contact [[stefan.raunser@mpi-dortmund.mpg.de|stefan.raunser@mpi-dortmund.mpg.de]]+The documentation has moved to [[https://cryolo.readthedocs.io/en/latest/|https://cryolo.readthedocs.io/en/latest/]]
  
-====== Paper ====== 
- 
-You can find more technical details in our paper: 
- 
-Nature Communications Biology: 
-[[https://doi.org/10.1038/s42003-019-0437-z|SPHIRE-crYOLO is a fast and accurate fully automated particle picker for cryo-EM]] 
- 
-Preprint: 
-[[https://www.biorxiv.org/content/10.1101/356584v2|SPHIRE-crYOLO: A fast and accurate fully automated particle picker for cryo-EM]] 
- 
-<html> 
-<a href="https://f1000.com/prime/733517098?bd=1" target="_blank"><img src="https://s3.amazonaws.com/cdn.f1000.com/images/badges/badgef1000.gif" alt="Access the recommendation on F1000Prime" id="bg" /></a> 
-</html> 
- 
-====== Download ====== 
- 
-<note important> 
-Before downloading or using this product, make sure you **understand and accept the [[:cryolo_license|terms of the license]]**.  
 </note> </note>
  
 +====== License ======
  
 +  * **Author:**  Thorsten Wagner
 +  * **License:** [[:cryolo_license|EULA]]
 +  * **Last Update:**  2018-06-20
 +If you are interested in using crYOLO in a commercial context please contact [[stefan.raunser@mpi-dortmund.mpg.de|]]
  
-====crYOLO====+====== Paper ======
  
-Version: 1.5.6 +You can find more technical details in our paper:
- +
-Uploaded:  17. December 2019 +
- +
-[[https://pypi.org/project/cryolo/#files|DOWNLOAD]] +
- +
-Please see [[downloads:cryolo_1#installation|install instructions]] how to get it running on the CPU. +
- +
-====crYOLO boxmanager==== +
- +
-Version: 1.2.9 +
- +
-Uploaded: 09. December 2019 +
- +
-[[https://pypi.org/project/cryoloBM/#files|DOWNLOAD]] +
- +
-[{{ :downloads:cryolophosaurusdb.jpg?150|**crYOLO Phosauraus**Net's eponym}}] +
- +
-==== General PhosaurusNet models ==== +
- +
-[[pipeline:window:cryolo:picking_general|Please see the tutorial how to use the general models]] +
- +
-=== For cryo images (low-pass filtered) === +
-Number of datasets: 43 real, 10 simulated, 10 particle free datasets on various grids with contamination +
- +
-Uploaded: 15. Oktober 2019 +
- +
-[[ftp://ftp.gwdg.de/pub/misc/sphire/crYOLO-GENERAL-MODELS/gmodel_phosnet_201912_N63.h5 +
-|DOWNLOAD]]  +
- +
-=== For cryo images (neural network denoised with JANNI) === +
-Number of datasets: 43 real, 10 simulated, 10 particle free datasets on various grids with contamination +
- +
-Uploaded: 15. Oktober 2019 +
- +
-[[ftp://ftp.gwdg.de/pub/misc/sphire/crYOLO-GENERAL-MODELS/gmodel_phosnet_201912_nn_N63.h5 +
-|DOWNLOAD]]  +
- +
-<note> +
-The performance of the general model based on JANNI denoised data compared to low-pass filtered data did not improve. The average AUC on the validation data was in both cases the same (0.85). But this might be because of the data selected for the general model. I assume that especially on very noisy micrographs JANNI will improve the results. +
-</note> +
- +
- +
- +
-=== For negative stain images === +
-Number of datasets: 10 real datasets +
- +
-Uploaded: 26. February 2019 +
- +
-[[ftp://ftp.gwdg.de/pub/misc/sphire/crYOLO-GENERAL-MODELS/gmodel_phosnet_negstain_20190226.h5 +
-|DOWNLOAD]]  +
-====ARCHIVE==== +
- +
-Previous versions of crYOLO, the boxmanager and the general models can be found here: [[http://sphire.mpg.de/wiki/doku.php?id=cryolo_archive#cryolo|Archive]]. +
- +
- +
-====== Installation ====== +
- +
-**System requirements:** +
- +
-crYOLO was tested on **Ubuntu 16.04.4 LTS** and **Ubuntu 18.04** with an NVIDIA Geforce 1080 / Geforce 1080Ti. +
- +
-However, it should run on **Windows** as well. +
- +
-As the GPU accelerated version of tensorflow does not support **MacOS**, crYOLO does not support it either. +
- +
- +
-crYOLO depends on CUDA Toolkit 9.0 and the cuDNN 7.1.2 library.  +
-It will be automatically installed during crYOLO installation. +
- +
-**Install crYOLO!** +
- +
-The following instructions assume that pip and [[https://conda.io/projects/conda/en/latest/user-guide/install/index.html|anaconda]] or [[https://docs.conda.io/en/latest/miniconda.html|miniconda]] are available. +
-In case you have a old cryolo environment installed, first remove the old one with: +
-<code> +
-conda env remove --name cryolo +
-</code> +
-After that, create a new virtual environment: +
-<code> +
-conda create -n cryolo -c anaconda python=3.6 pyqt=5 cudnn=7.1.2 numpy==1.14.5 cython wxPython==4.0.4 intel-openmp==2019.4 +
-</code> +
- +
-Activate the environment: +
-<code> +
-source activate cryolo +
-</code> +
- +
-In case you run **crYOLO on a GPU** run: +
-<code> +
-pip install 'cryolo[gpu]'  +
-</code> +
- +
-But if you want to run **crYOLO on a CPU** run: +
-<code> +
-pip install 'cryolo[cpu]'  +
-</code> +
- +
-<note> +
-During the installation of crYOLO you will see the following error message: +
-''ERROR: imagecodecs-lite 2019.2.22 has requirement numpy>=1.15.4, but you'll have numpy 1.14.5 which is incompatible.'' +
-However, you can ignore it. It is actually also working with numpy==1.14.5 +
-</note> +
- +
-<note tip> +
-In case you want to integrate crYOLO in your module system, [[pipeline:window:cryolo:integration_into_module_system|here is a brief explanation]]. +
-</note> +
- +
- +
-<note important> +
-**Known issues** +
- +
-  * Issue 0: Training on multiple GPUs sometimes lead to worse performance (higher loss). We currently recommend to train on single gpus. +
-  * Issue 17: On the fly filtering (%%--%%otf) is slower than using it not, as the filtering is not parallelized in this case.  +
-  * Issue 27: Filament mode is not working with micrographs motion corrected by unblur. Will be fixed in the next release. +
- +
- +
- +
-<hidden Closed issues> +
-  * <del>  Issue 1: crYOLO sometimes not exit properly after training finished. Has to be killed manually.</del> +
-  * <del>Issue 2: If you use automatic filtering with .tif files, you get an error like "OSError: cannot identify image file 'filtered_folder/another_folder/my_image.tif'". It will be fixed in the next release.</del> +
-  * <del>Issue 3: (Boxmanager) The visualization only shows the first filament when loading eman1 helical box files (start end coordinates). Will be fixed in the next release.</del> +
-  * <del>Issue 4: The filament mode will crash if crYOLO cannot identify a single particle in the image. Will be fixed in 1.2.2</del> +
-  * <del>Issue 5: If movies were aligned with cisTEM and picked with crYOLO, the box position are vertically flipped. Will be fixed in 1.2.2</del> +
-  * <del>Issue 6: crYOLO does overwrite the environmental variable "CUDA_VISIBLE_DEVICES" with 0 if no gpu is specified by the -g parameter. This leads to the behavior that crYOLO ignores previous settings in CUDA_VISIBLE_DEVICES. Will be fixed in 1.2.2</del> +
-  * <del>Issue 7: On K3 images crYOLO seems to add a offset toward the longer axis of the input image.</del> +
-  * <del>Issue 8: There is a logical error in filament tracing, which sometimes connects two parallel filaments.</del> +
-  * <del>Issue 9: Some people report an error when running cryolo prediction/training: "ImportError: numpy.core.multiarray failed to import". It will be fixed in 1.2.3.</del> +
-  * <del>Issue 10: On machines with many cores (e.g 64) an error during filtering might pop up: "[ERROR:0] 53: Can't spawn new thread"</del> +
-  * <del>Issue 11: If the -g parameter is not provided, crYOLO will use the memory of all GPUs. Will be fixed in 1.2.3.</del> +
-  * <del>Issue 12: The LineEnhancer depdenceny of crYOLO is still dependent from opencv. Workaround: In the crYOLO environment: conda install opencv</del> +
-  * <del>Issue 13: After picking it can happen that some of the boxes are not fully immersed in the image. Will be fixed in 1.2.4.</del> +
-  * <del>Issue 14: Parallelization in filament mode is broken. Will be fixed in 1.2.4.</del> +
-  * <del>Issue 15: If the %%--%%gpu_fraction is used, crYOLO always uses GPU 0. Will be fixed in 1.3.1.</del>  +
-  * <del>Issue 16: %%--%%gpu_fraction only works for prediction, not for training. Will be fixed in 1.3.2.</del> +
-  * <del>Issue 18: Prediction is broken in 1.3.2. It removes all particles as it claim they are not fully immersed in the image.</del> +
-  * <del>Issue 19: Filtering does not work if target image directory is absolute path.</del> +
-  * <del>Issue 20: crYOLO 1.3.4 has a normalization bug. During training the images are normalized seperately, but during prediction is done batch wise. Workaround: Use -pbs 1 during prediction. It will be fixed in 1.3.5.</del> +
-  * <del>Issue 21: The search range for filament tracing is too low for many datasets. To check if you are affected: Use your trained model and pick without the filament options. Check if your filaments a nicely picked (many consecutive boxes on a filament). In the next version, the search range will be increased and added as an optional parameter.</del> +
-  * <del>Issue 22: If absolute paths are used in the field "train_image" in your configuration file, filtering is skipped.</del> +
-  * <del>Issue 23: Since crYOLO 1.4.0 it sometimes take long until it starts picking. The reason seems to be the tensorflow update.<del> +
-  * <del>Issue 24: Fine-tune mode does not start (cannot find layer model_3). Will be fixed in 1.4.1.<del> +
-  * <del>Issue 25: When using GUI, prediction behaves differently than using command line. The reason is, that it uses a different multiprocessing start method. Will be fixed with 1.5.1</del> +
-  * <del>Issue 26: If you select filtering "None" crYOLO does not train properly.</del> +
-</hidden> +
-</note> +
- +
-**That's it!** +
- +
-You might want to check if everything is running as expected. Here is a reference example: +
- +
-[[http://sphire.mpg.de/wiki/doku.php?id=cryolo_reference_example#reference_setup|Reference example with TcdA1]] +
- +
-===== Run it on the CPU ==== +
- +
-There is also a way to run crYOLO on CPU. To use it, just follow the instruction in the [[downloads:cryolo_1#installation|install section]]. This is especially useful when you would like to apply the generalized model and don't have a NVIDIA GPU.  +
- +
-Picking with crYOLO is also quite fast on the CPU. On my local machine (Intel i9) it takes roughly 1 second per micrograph and on our low-performance notebooks (Intel i3) 4 seconds.  +
- +
-Training crYOLO is much more computational expensive. Training a model with 14 micrographs from scratch on my local machine take 34 minutes per epoch on the CPU. Given that you often need 25 epochs until convergence it is a task to do overnight (~ 12 hours). However, you might want to try [[pipeline:window:cryolo##picking_particles_-_using_the_general_model_refined_for_your_data|refining the general model]], which takes 12 minutes per epoch (~ 5 hours). +
- +
-====== Tutorials ====== +
- +
-Use our **__''[[pipeline:window:cryolo|step-by-step tutorials]]''__** to get started! +
- +
-====== Change log ====== +
- +
-====crYOLO==== +
-{{page>pipeline:window:cryolo:changelog}} +
-====crYOLO Boxmanager==== +
- +
-**crYOLO Boxmanager Version 1.2.9:** +
-  * Fixed a problem that only one filament is shown +
- +
-**crYOLO Boxmanager Version 1.2.8:** +
-  * Add a low pass filter +
- +
-<hidden **Old crYOLO Boxmanager change logs**> +
- +
-**crYOLO Boxmanager Version 1.2.6:** +
-  * Make it compatible with current new environment +
- +
-**crYOLO Boxmanager Version 1.2.3:** +
-  * Make it compatible with current new environment +
- +
-**crYOLO Boxmanager Version 1.2.2:** +
-  * Makes sure that the correct version of MatplotLib is used. +
- +
-**crYOLO Boxmanager Version 1.2.1:** +
-   * Press "h" for hiding the boxes +
-   * Fix for loading different box sets with different colors for the case that on of the box sets are cbox files. +
- +
-**crYOLO Boxmanager Version 1.2:**  +
-  * Add interactive threshold selection using cbox files +
- +
-**crYOLO Boxmanager Version 1.1.1:**  +
-  * Fix Issue 3 +
-  * Now supports STAR Start-End filament format +
- +
-**crYOLO Boxmanager Version 1.1.0:** +
-  * Switch to Python3 +
-  * Minor bug fixes +
- +
-**crYOLO Boxmanager Version 1.0.4:** +
-  * Support of visualization of EMAN1 filament coordinates +
-  * Make compatible with crYOLO 1.1.3 +
- +
-**crYOLO Boxmanager Version 1.0.3:** +
-  * Support of visualization of EMAN2 helical coordinates (particle coordinates) +
-  * New boxes could be loaded with a new color while keeping the old. +
-  * Fix problem with makes loading images very long. +
-  * Several bug fixes +
- +
-**crYOLO Boxmanager Version 1.0.2:** +
-  * Fix problem with invisible (start with .) files. Now they are ignored. +
- +
-**crYOLO Boxmanager Version 1.0.1:** +
-  * Fix crash when cancel import boxfiles +
-  * Fix crash with qt4 +
-</hidden> +
-==== General PhosaurusNet model ==== +
-**Version 201912:**: +
-  * Added two more datasets. +
- +
-**Version 20190516:**: +
-  * Added four more inhouse datasets +
-  * Added SNRNP (Thanks to Clement Charenton)  +
- +
-<hidden Old General PhosaurusNet model change logs> +
-**Version 20190315:**: +
-  * Added KLH +
-  * Added one inhouse dataset +
- +
-**Version 20190218:** +
-  * Added K3 apoferritin (Thanks to Shaun Rawson) +
-  * Added two more inhouse datasets  +
- +
-**Version 20181221:** +
-  * Same datasets as the general YOLO network model version 20181120 but with trained with PhosaurusNet. +
-</hidden> +
-==== General YOLO network model in patch mode ==== +
-<hidden Old general YOLO network model in patch mode> +
-**Version 20181120:**+
  
-Added multiple simulated datasets, where each micrograph contains hundreds of particles with different defocus: +Communications Biology[[https://doi.org/10.1038/s42003-019-0437-z|SPHIRE-crYOLO is a fast and accurate fully automated particle picker for cryo-EM]]
-  * PDB 1SA0 +
-  * PDB 5LNK +
-  * PDB 5XNL +
-  * PDB 6B7N +
-  * PDB 6BHU +
-  * PDB 6DMR +
-  * PDB 6DS5 +
-  * PDB 6GDG +
-  * PDB 6H3N +
-  * PDB 6MPU+
  
-Besides these simulated datasets we added handpicked +Preprint: [[https://www.biorxiv.org/content/10.1101/356584v2|SPHIRE-crYOLO: A fast and accurate fully automated particle picker for cryo-EM]]
-  * ATP Synthase +
-  * DNA Origami +
-  * Two more particle-free only-contamination datasets.+
  
-It total 45  datasets are now included.+{{:badgef1000.gif?www.google.de&120x28}}
  
-**Version 20180823:**+https://f1000.com/prime/733517098?bd=1
  
-Increase the number of hand picked datasets to 25 by adding: +<note warning> 
-  * Add EMPIAR 10154 (Thanks to Daniel Prumbaum) +
-  * Add EMPIAR 10186 (Thanks to Sebastian Tacke) +
-  * Add EMPIAR 10097 Hemagglutinin (Thanks to Birte Siebolds) +
-  * Add EMPIAR 10081 HCN1 (Thanks to Pascel Lill) +
-  * Add internal dataset (Thanks to Daniel Roderer) +
-  * Furthermore we added 8 datasets of protein-free grids (Thanks to Tobias Raisch and Daniel Prumbaum)+
  
-**Version 20180720:**+**DOCUMENTATION OUTDATED**  
  
-Added micrographs of 7 new handpicked datasets: +The documentation has moved to  https://cryolo.readthedocs.io/en/latest/  
-   * EMPIAR 10181 (Thanks to Dennis Quentin) +
-   * EMPIAR 10017  +
-   * EMPIAR 10028 (Thanks to Oleg Sitsel) +
-   * User contributed dataset (Thanks to Lifei Fu) +
-   * EMPIAR 10089  +
-   * EMPIAR 10004 (Thanks to Daniel Roderer) +
-   * EMPIAR 10072 (Thanks to Tobias Raisch) +
-Furthermore I had to remove one internal dataset, as it turned out that it is unsuitable for training the general model.+
  
-**Version 20180704:**+</note> 
  
-Added three more handpicked datasets:  
-  * spliceosome (EMPIAR 10160) 
-  * picornavirus (EMPIAR 10033) and  
-  * an internal dataset.  
-</hidden> 
  
downloads/cryolo_1.txt · Last modified: 2021/02/19 09:43 by twagner