Difference between revisions of "CCTBX"

From PyMOLWiki
Jump to navigation Jump to search
(CCTBX-fedora32)
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Computational Crystallography Toolbox=
+
This page describes how to use the [https://github.com/cctbx/cctbx_project Computational Crystallography Toolbox (cctbx)] with PyMOL.
[http://cctbx.sourceforge.net cctbx]
 
  
==Using With PyMol==
+
cctbx and PyMOL need to be compiled with the same Python distribution, otherwise they won't be compatible.
  
===On a Mac===
+
=== Incentive PyMOL ===
There is a page on the cctbx with special instructions for using it on the Mac [http://cci.lbl.gov/cctbx_build/mac_os_x_notes.html cctbx On Mac].  Note that you need to use the "Framework" build of PyMOL [http://delsci.com/frameworkpymol/ FrameWorkPyMol].
 
  
===Windows XP (Roger Dodd)===
+
Using cctbx with Incentive PyMOL 2.x should become easier once the cctbx project provides conda packages.
1. Download and install python (to the default location - C:\Python24)
+
See https://github.com/cctbx/cctbx_project/issues/9
  
[http://www.python.org/ftp/python/2.4.1/python-2.4.1.msi Python-2.4.1]
+
==== Linux ====
  
1a. If you want to use the draw_symops.py or draw_symops_cctbx.py
+
Confirmed procedure to get this working on Linux with CCTBX build '''dev-1723''', which is based on conda:
scripts you also need to install numarray after installing python
 
  
[http://prdownloads.sourceforge.net/numpy/numarray-1.3.3.win32-py2.4.exe?download Numarray-1.3.3]
+
# Download cctbx from http://cci.lbl.gov/cctbx_build/
 +
# Install cctbx: <code>./install --prefix=$HOME/local</code>
 +
# Install [https://repo.continuum.io/miniconda/ Miniconda]
 +
# Install '''pymol''' with '''conda''' into the '''cctbx environment''':<syntaxhighlight lang="bash">$HOME/miniconda3/bin/conda install -p $HOME/local/cctbx-dev-1723/conda_base -c schrodinger -c conda-forge pymol</syntaxhighlight>
 +
# Activate cctbx: <code>source $HOME/local/cctbx-dev-1723/cctbx_env.sh</code>
 +
# Run PyMOL with: <code>cctbx.python -m pymol</code>
  
2. Download cctbx *without* python included and unpack into
+
==== Windows ====
C:\cctbx_build and C:\cctbx_sources (i.e. execute the file in C:\)
 
  
[http://cci.lbl.gov/cctbx_build/ cctbx]
+
Confirmed procedure to get this working on Windows with CCTBX build '''dev-1725''', which is based on conda:
  
3. Download pymol built against python 2.4 (but not including its own
+
# Download cctbx from http://cci.lbl.gov/cctbx_build/
python) and install in the default location
+
# Extract ZIP file (e.g. to <code>F:\cctbx-installer-dev-1725-intel-windows-x86_64</code>)
 +
# Install [https://repo.continuum.io/miniconda/ Miniconda]
 +
# Install '''pymol''' with '''conda''' into the '''cctbx environment''': <code>conda install -p F:\cctbx-installer-dev-1725-intel-windows-x86_64\conda_base -c schrodinger -c conda-forge pymol</code>
 +
# Activate cctbx: <code>call F:\cctbx-installer-dev-1725-intel-windows-x86_64\cctbx_env.bat</code>
 +
# Run PyMOL with: <code>cctbx.python -m pymol</code>
  
[http://delsci.com/rel/098/pymol-0_98rc5-bin-win32-py24.zip pymol-0_98rc5]
+
=== Open-Source PyMOL ===
  
(Newer versions of PyMOL linked against an external python are available from Delano Scientific on request for holders of a valid subscription.)
+
See [[CCTBX-fedora32]].
 
 
4. Create 2 files (use notepad or wordpad or any other text editor) and
 
save in the C:\Program Files\Delano Scientific\PyMOL directory:
 
 
 
    a) pymol.cmd
 
 
 
      @cctbx.python -x "%~f0" %* & exit /b
 
        import cctbx
 
        import pymol
 
 
 
    b) run.cmd
 
 
 
        CALL C:\cctbx_build\setpaths_all.bat
 
        CALL "C:\Program Files\Delano Scientific\PyMOL\pymol.cmd"
 
 
 
5. It's important to have python in your path variable (which you can access by going to control panel|system|advanced|environment variables), just add C:\python24 to the end of the path variable, separated by a semi-colon.
 
 
 
===Linux (Robert Campbell)===
 
When you run the setpaths.sh script, it adds the cctbx_build/bin directory to the *front* of your $PATH. In that directory is a shell script called "python" that sets the environment necessary to import cctbx. So, to get cctbx to work, you have to call python without prefixing a directory path.  If you were like me and had:
 
/usr/bin/python  $PYMOL_PATH/modules/launch_pymol.py $*
 
in your pymol.com file, then it would not run that cctbx_build/bin/python script. So you need to either change the above line to:
 
python  $PYMOL_PATH/modules/launch_pymol.py $*
 
(assuming you've already run the setpaths.sh script) or you need to copy the cctbx_build/bin/python contents (without the actual "python" command) into your pymol.com file or some other file that you source before pymol.com.
 
 
 
Within pymol, type the command:
 
print sys.path
 
and you should now see the cctbx directories show up.
 
  
 
[[Category:PyMol_Integration|cctbx]]
 
[[Category:PyMol_Integration|cctbx]]

Revision as of 15:59, 11 May 2020

This page describes how to use the Computational Crystallography Toolbox (cctbx) with PyMOL.

cctbx and PyMOL need to be compiled with the same Python distribution, otherwise they won't be compatible.

Incentive PyMOL

Using cctbx with Incentive PyMOL 2.x should become easier once the cctbx project provides conda packages. See https://github.com/cctbx/cctbx_project/issues/9

Linux

Confirmed procedure to get this working on Linux with CCTBX build dev-1723, which is based on conda:

  1. Download cctbx from http://cci.lbl.gov/cctbx_build/
  2. Install cctbx: ./install --prefix=$HOME/local
  3. Install Miniconda
  4. Install pymol with conda into the cctbx environment:
    $HOME/miniconda3/bin/conda install -p $HOME/local/cctbx-dev-1723/conda_base -c schrodinger -c conda-forge pymol
    
  5. Activate cctbx: source $HOME/local/cctbx-dev-1723/cctbx_env.sh
  6. Run PyMOL with: cctbx.python -m pymol

Windows

Confirmed procedure to get this working on Windows with CCTBX build dev-1725, which is based on conda:

  1. Download cctbx from http://cci.lbl.gov/cctbx_build/
  2. Extract ZIP file (e.g. to F:\cctbx-installer-dev-1725-intel-windows-x86_64)
  3. Install Miniconda
  4. Install pymol with conda into the cctbx environment: conda install -p F:\cctbx-installer-dev-1725-intel-windows-x86_64\conda_base -c schrodinger -c conda-forge pymol
  5. Activate cctbx: call F:\cctbx-installer-dev-1725-intel-windows-x86_64\cctbx_env.bat
  6. Run PyMOL with: cctbx.python -m pymol

Open-Source PyMOL

See CCTBX-fedora32.