Differences between revisions 2 and 93 (spanning 91 versions)
Revision 2 as of 2015-10-14 17:32:54
Size: 1026
Editor: SteveLudtke
Comment:
Revision 93 as of 2016-06-03 19:04:12
Size: 9094
Comment:
Deletions are marked like this. Additions are marked like this.
Line 4: Line 4:
It is critical that all participants in the tutorials have all required software installed and tested before they leave for the workshop. This is why we are giving you instructions 2 weeks in advance. We are happy to assist people via email in advance of the workshop. At the workshop itself, if you try and install the software during the session, you will almost certainly not keep up with the tutorials, and may have a miserable experience! '''''We strongly recommend bringing a 3 button (or 2 button+scroll) mouse. While it is possible to survive with a trackpad or one button mouse, there are many things in EMAN and Chimera where having additional mouse buttons is VERY useful.'''''
Line 6: Line 6:
The official agenda is on the [[http://ncmi.bcm.edu/ncmi/events/workshops/workshops_145|Workshop Page]]
Line 7: Line 8:
Please insure that you have the following software packages installed:
 * EMAN/SPARX 2.12 (or snapshot version released after Oct. 16, 2015)
 * [[https://www.cgl.ucsf.edu/chimera/download.html|Chimera]] 1.10 or newer
 * Gorgon ...
 * [[http://www2.mrc-lmb.cam.ac.uk/relion/index.php/Download_%26_install|Relion 1.4]] (optional) - The Relion session will largely be a demo, if you wish to have it installed to experiment during the workshop you may
'''Presentation notes from the Workshop''' (some of these have not been uploaded yet)
 * [[attachment:wah-introduction.pdf]] - Introduction to the Workshop and NCMI
 * [[attachment:ludtke-overview.pdf||&do=get]] - Workshop Overview - Steve Ludtke
 * [[attachment:mcmullanintro.pdf]] - Electron Microscopes & Imaging Artifacts - Greg !McMullan
 * [[attachment:penczek-alignment.pdf||&do=get]] - 2D Alignment Theory - Pawel Penczek
 * [[attachment:ludtke-minitalks.pdf||&do=get]] - CTF, Refinement, other topics - Steve Ludtke
 * [[attachment:baldwin-orientation.pdf]] - Orientation and Symmetry - Phil Baldwin
 * [[attachment:scheres-heterogeneity.pdf]] - Methods for Heterogeneity Analysis - Sjors Scheres
 * [[attachment:mcmullanDetector.pdf]] - Direct Detector Technology - Greg !McMullan
 * [[attachment:pintilie.pdf]] - Chimera & Segger - Greg Pintilie
 * [[attachment:baker-model-building.pdf||&do=get]] - Model Building - Matt Baker
 * [[attachment:lawson-challenges.pdf]] - EMDB Challenges - Cathy Lawson

'''Video of selected sessions'''
Our primary video recording mechanism failed to record audio, so we unfortunately have only the EMAN and Modeling tutorials recorded
 * [[http://blake.grid.bcm.edu/videos/NCMI_workshop_2015/Ludtke_session_1-Workshop_intro.mp4|Ludtke - Workshop Introduction]]
 * [[http://blake.grid.bcm.edu/videos/NCMI_workshop_2015/Ludtke_session_2-EMAN2_tutorial_1.mp4|EMAN2.12 Tutorial - Part 1]] (session starts at 4:20 in video)
 * [[http://blake.grid.bcm.edu/videos/NCMI_workshop_2015/Ludtke_session_3-class_eval.mp4|EMAN2.12 Tutorial - Part 2 - 2-D Class averages]]
 * [[http://blake.grid.bcm.edu/videos/NCMI_workshop_2015/Ludtke_session_4-e2refine_easy.mp4|EMAN2.12 Tutorial - Part 3 - Starting your first refinement]]
 * [[http://blake.grid.bcm.edu/videos/NCMI_workshop_2015/Ludtke_session_5-e2refine_easy_results.mp4|EMAN2.12 Tutorial - Part 4 - Looking at the results of the first refinement]]
 * [[http://blake.grid.bcm.edu/videos/NCMI_workshop_2015/Ludtke_session_6-heterogeneity.mp4|Compositional and conformational variability in EMAN2.12 - Part 1]]
 * [[http://blake.grid.bcm.edu/videos/NCMI_workshop_2015/Ludtke_session_7-heterogeneity_2.mp4|Compositional and conformational variability in EMAN2.12 - Part 2]]
 * [[http://blake.grid.bcm.edu/videos/NCMI_workshop_2015/Baker_modeling_tutorial.mp4|Baker - Model building tutorial]]

'''Tutorial PDFs'''
 * [[attachment:EMAN2-12_Tutorial.pdf||&do=get]]
 * [[attachment:EMAN2-12_Tutorial2_heterogeneity.pdf||&do=get]]
  * Please note that e2refine_split has been improved significantly since 2.12. Suggest an update if using this method.
 * [[http://ncmi.bcm.edu/ncmi/software/segger/docs|Segger Tutorials]]
 * [[attachment:PathwalkerGorgonTutorial.pdf||&do=get]]
 * [[attachment:ModelOptimizationTutorial.pdf||&do=get]]
 * [[attachment:ModelValidationTutorial.pdf||&do=get]]

'''Tutorial Data'''
You will also need all of the demonstration data, which we will use when going through the tutorials:
 * [[attachment:Bgal.zip||&do=get]]
 * [[attachment:ribosome.zip||&do=get]]
 * [[attachment:segger_workshop_files.zip||&do=get]]
 * [[attachment:sparx_sorting.tgz||&do=get]]
 * Data-Sets.zip from [[https://github.com/GorgonCryoEM/Gorgon/releases/tag/workshop-2015|Gorgon site]]
 * [[attachment:sparx_ctf.tgz||&do=get]] - NEW
 * [[attachment:Optimize-tutorial.zip||&do=get]]
 * [[attachment:Validate-tutorial.zip||&do=get]]

'''Completed Tutorial Projects (large files)'''
 * [[attachment:Bgal-completed-tutorial.zip||&do=get]] Result of EMAN high res tutorial (warning, 6 GB download)
 * [[attachment:ribosome_Relion.zip||&do=get]] Result of Relion tutorial
 * [[attachment:Optimize_Results.zip||&do=get]]

'''Software used at the workshop:'''
 * [[http://ncmi.bcm.edu/ncmi/software/counter_222/software_133|EMAN/SPARX 2.12]] (or snapshot version released after Oct. 19, 2015) - (day 1 - 2) Required. Do not use an older version.
 * [[http://www2.mrc-lmb.cam.ac.uk/relion/index.php/Download_%26_install|Relion 1.4]] (optional, day 2-3) - The Relion session will largely be a demo. See comments below.
 * [[https://www.cgl.ucsf.edu/chimera/download.html#daily|Chimera Daily Build]] Oct. 17 or later - For PDB viewing and Segger tutorial (day 4, specific version required)
 * Warning: we are aware of an issue with Gorgon on Ubuntu. Will remove this warning when resolved. Other Linux variants should be fine, now.
 * [[https://github.com/GorgonCryoEM/Gorgon/releases/tag/workshop-2015|Gorgon]] - Gorgon Tutorial (day 4) Please install the appropriate binary AND Data-Sets.zip
 * [[http://www.phenix-online.org/download/|Phenix]] - (end of day 4) real-space refinement of models
 * [[http://www.akira.ruc.dk/~keld/research/LKH/|LKH Solver]] - (day 4 - pathwalker), required only for the pathwalker tutorial, see below
 * [[http://www.open-mpi.org/|OpenMPI]] and [[http://ncmi.bcm.edu/ncmi/software/counter_222/software_121|PyDusa]] (day 2-3) SPARX tutorial may also largely be a demo, see below

----
=== Additional information and tips about software installation ===
These are not additional downloads, but rather are links which may assist in installing some of the required packages above.

 * Please insure that you meet the specific version requirements above for each software package. Tutorials will be tested only on these specific versions.
 * Mac users - If you are running El Capitan on your Mac (10.11) you will find there are a few bugs specific to this OS version we have not managed to fix yet. It should still be possible to complete the tutorial, but you will encounter a few annoyances.
 * OpenMPI/Pydusa - Most SPARX tasks require MPI to run correctly, and are normally used on clusters. It is possible to install MPI on a single laptop/desktop as well, and requires minimal work or configuration to do so, you will simply be limited to the number of CPUs available on your laptop. Much of the SPARX presentation will be 'demo style' rather than a formal tutorial anyway, so you will not miss too much if you don't get MPI configured. Instructions are available [[http://blake.bcm.edu/emanwiki/EMAN2/Parallel/Mpi|here]].
 * Due to the required computation for most Relion refinements, Sjors plans to run a demo-style session rather than a tutorial. However, if you install Relion, you may be able to experiment with it a bit during the session. This is recommended only for users with Linux on their laptops.
 * Chimera and Phenix have some restrictions on commercial use. If you work for a commercial entity, and your IT group will not install these packages, you will still be able to directly participate in most of the workshop. Phenix will only be used at the very end of day 4 to learn about real-space refinement. Chimera will be used on day 4 for a segmentation tutorial. It is also a useful utility to have available, but should otherwise not be strictly required.
 * Warning - there may be some minor issues with EMAN/SPARX 2.12 on MacOS ElCapitan. If you have not upgraded, you may consider delaying until after the workshop.
 * Installing EMAN2/SPARX:
  * Instructions are here: [[http://blake.bcm.edu/emanwiki/EMAN2/Install/BinaryInstall]]
 * Installing Phenix:
  * Go to http://www.phenix-online.org/download/ and click request download instructions.
  * Register (http://www.phenix-online.org/phenix_request/index.cgi) with institutional email address.
  * Then an email with a password for the download will be sent to the registered email address.
  * Use the provided link and password to download the latest official release (for example: Latest official release: 1.10.1-2155 (10-06-2015)).
  * The user should then install the command line operator version for their particular operating system.
  * Unzip the downloaded file (~918MB) and follow the install instructions in the README file (you may need to use > sudo ./install). I would suggest to install in the default directory (usr/local/..).
  * Once you have successfully installed PHENIX, to set up your environment please source the phenix_env file in the phenix installation directory (as stated in the README file).
 * Installing LKH Solver
  * For linux you can download source and compile using the link above
  * For the Mac
   * You can build from source if you have Xcode - or -
   * We are providing a Mac binary [[attachment:lkh]] you can 'chmod a+x lkh' then copy to /usr/local/bin (or another folder in your $PATH)
  * For Windows, there is a binary version available: [[http://www.akira.ruc.dk/~keld/research/LKH/lkh.exe]]

NCMI Workshop on Single Particle Reconstruction, Structural Variability and Modeling

Oct 30 - Nov 2, 2015

We strongly recommend bringing a 3 button (or 2 button+scroll) mouse. While it is possible to survive with a trackpad or one button mouse, there are many things in EMAN and Chimera where having additional mouse buttons is VERY useful.

The official agenda is on the Workshop Page

Presentation notes from the Workshop (some of these have not been uploaded yet)

Video of selected sessions Our primary video recording mechanism failed to record audio, so we unfortunately have only the EMAN and Modeling tutorials recorded

Tutorial PDFs

Tutorial Data You will also need all of the demonstration data, which we will use when going through the tutorials:

Completed Tutorial Projects (large files)

Software used at the workshop:

  • EMAN/SPARX 2.12 (or snapshot version released after Oct. 19, 2015) - (day 1 - 2) Required. Do not use an older version.

  • Relion 1.4 (optional, day 2-3) - The Relion session will largely be a demo. See comments below.

  • Chimera Daily Build Oct. 17 or later - For PDB viewing and Segger tutorial (day 4, specific version required)

  • Warning: we are aware of an issue with Gorgon on Ubuntu. Will remove this warning when resolved. Other Linux variants should be fine, now.
  • Gorgon - Gorgon Tutorial (day 4) Please install the appropriate binary AND Data-Sets.zip

  • Phenix - (end of day 4) real-space refinement of models

  • LKH Solver - (day 4 - pathwalker), required only for the pathwalker tutorial, see below

  • OpenMPI and PyDusa (day 2-3) SPARX tutorial may also largely be a demo, see below


Additional information and tips about software installation

These are not additional downloads, but rather are links which may assist in installing some of the required packages above.

  • Please insure that you meet the specific version requirements above for each software package. Tutorials will be tested only on these specific versions.
  • Mac users - If you are running El Capitan on your Mac (10.11) you will find there are a few bugs specific to this OS version we have not managed to fix yet. It should still be possible to complete the tutorial, but you will encounter a few annoyances.
  • OpenMPI/Pydusa - Most SPARX tasks require MPI to run correctly, and are normally used on clusters. It is possible to install MPI on a single laptop/desktop as well, and requires minimal work or configuration to do so, you will simply be limited to the number of CPUs available on your laptop. Much of the SPARX presentation will be 'demo style' rather than a formal tutorial anyway, so you will not miss too much if you don't get MPI configured. Instructions are available here.

  • Due to the required computation for most Relion refinements, Sjors plans to run a demo-style session rather than a tutorial. However, if you install Relion, you may be able to experiment with it a bit during the session. This is recommended only for users with Linux on their laptops.
  • Chimera and Phenix have some restrictions on commercial use. If you work for a commercial entity, and your IT group will not install these packages, you will still be able to directly participate in most of the workshop. Phenix will only be used at the very end of day 4 to learn about real-space refinement. Chimera will be used on day 4 for a segmentation tutorial. It is also a useful utility to have available, but should otherwise not be strictly required.
  • Warning - there may be some minor issues with EMAN/SPARX 2.12 on MacOS ElCapitan. If you have not upgraded, you may consider delaying until after the workshop.

  • Installing EMAN2/SPARX:
  • Installing Phenix:
    • Go to http://www.phenix-online.org/download/ and click request download instructions.

    • Register (http://www.phenix-online.org/phenix_request/index.cgi) with institutional email address.

    • Then an email with a password for the download will be sent to the registered email address.
    • Use the provided link and password to download the latest official release (for example: Latest official release: 1.10.1-2155 (10-06-2015)).
    • The user should then install the command line operator version for their particular operating system.
    • Unzip the downloaded file (~918MB) and follow the install instructions in the README file (you may need to use > sudo ./install). I would suggest to install in the default directory (usr/local/..).

    • Once you have successfully installed PHENIX, to set up your environment please source the phenix_env file in the phenix installation directory (as stated in the README file).
  • Installing LKH Solver
    • For linux you can download source and compile using the link above
    • For the Mac
      • You can build from source if you have Xcode - or -
      • We are providing a Mac binary lkh you can 'chmod a+x lkh' then copy to /usr/local/bin (or another folder in your $PATH)

    • For Windows, there is a binary version available: http://www.akira.ruc.dk/~keld/research/LKH/lkh.exe

Ws2015 (last edited 2016-06-03 19:04:12 by SnekaRaveendran)