Installation: Difference between revisions

Jump to navigation Jump to search
(18 intermediate revisions by 2 users not shown)
Line 3: Line 3:


== Linux ==
== Linux ==
Log in as root - we need write permission for /usr/local/bin .
'''Log in as root''' - we need write permission for /usr/local/bin .


=== [[XDS]] package ===
=== [[XDS]] package ===
If you are an academic user,
If you are an academic user, as root
<pre>
<pre>
  cd /usr/local/bin
  cd /usr/local/bin
Line 12: Line 12:
  ln -sf XDS-INTEL64_Linux_x86_64/* .
  ln -sf XDS-INTEL64_Linux_x86_64/* .
</pre>
</pre>
In case the [ftp://ftp.mpimf-heidelberg.mpg.de/pub/kabsch above site] is unavailable, there is a [https://strucbio.biologie.uni-konstanz.de/pub/xds backup site].


=== other programs: [[XDS-Viewer]], [[XDSSTAT]], [[XDSCC12]], [[XDSGUI]], [[XSCALE_ISOCLUSTER]]  ===
=== other programs: [[XDS-Viewer]], [[XDSSTAT]], [[XDSCC12]], [[XDSGUI]], [[XSCALE_ISOCLUSTER]]  ===
... can be downloaded from ftp://turn5.biologie.uni-konstanz.de/pub/linux_bin/ . A simple way to obtain them is
... can be downloaded from https://{{SERVERNAME}}/pub/linux_bin/ . A simple way to obtain them is to create an empty folder, "cd" to that folder and then (as root)
  wget ftp://turn5.biologie.uni-konstanz.de/pub/linux_bin/get_folder.sh
  wget https://{{SERVERNAME}}/pub/linux_bin/get_folder.sh
  chmod +x get_folder.sh
  chmod +x get_folder.sh
  ./get_folder.sh
  ./get_folder.sh
Line 23: Line 24:
Since XDSGUI depends on graphics packages that may need to be installed, you can check the xdsgui binary with
Since XDSGUI depends on graphics packages that may need to be installed, you can check the xdsgui binary with
  ldd `which xdsgui`
  ldd `which xdsgui`
and that should show you the libraries it found, and more importantly, those that it didn't find. Your friendly system administrator will then work out the specific commands to install those libraries; on RedHat-type distributions that would typically be e.g. <code>yum provides libXfixes.so.3</code> the output of which will tell you that this is in the libXfixes RPM.
and that should show you the libraries it found, and more importantly, those that it didn't find. Your friendly system administrator will then work out the specific commands to install those libraries; on RedHat-type distributions that would typically be e.g. <code>yum provides libXfixes.so.3</code> the output of which will tell you that this is in the libXfixes RPM. <code>xds-viewer</code> needs libpng12.so.0 which can be installed with <code>yum install libpng12</code>.
Ubuntu 14 users: please read http://strucbio.biologie.uni-konstanz.de/xdswiki/index.php/XDSGUI#Installation if you have a problem with missing libmng2.
 
Ubuntu 18.04: if libQtOpenGL.so.4 is missing, use <code>sudo apt install libqt4-opengl</code>, and if libpng12.so is missing (xds-viewer needs it), install it from [https://packages.ubuntu.com/xenial/amd64/libpng12-0/download] .


Of course, this still requires installation of <code>xxdiff</code> (or alternative), and for .h5 data: HDF5 package, and <code>H5ToXds</code> and/or [https://www.dectris.com/company/news/newsroom/news-details/process-eiger-data-with-xds-fast Neggia] library.
Of course, this still requires installation of <code>xxdiff</code> (or alternative), and for .h5 data: HDF5 package, and <code>H5ToXds</code> and/or [https://www.dectris.com/company/news/newsroom/news-details/process-eiger-data-with-xds-fast Neggia] library.
Line 32: Line 34:
on RHEL6/CentOS6/SL6 systems, or
on RHEL6/CentOS6/SL6 systems, or
  apt-get install xxdiff
  apt-get install xxdiff
on Ubuntu.
on Ubuntu. If Ubuntu 20.04 doesn't find it, use the latest from http://archive.ubuntu.com/ubuntu/pool/universe/x/xxdiff/


An <code>xxdiff</code> binary that runs on CentOS7 (RHEL7, SL7) is provided by the <code>get_folder.sh</code> script.
An <code>xxdiff</code> binary that runs on CentOS7 (RHEL7, SL7) is provided by the <code>get_folder.sh</code> script.
Line 39: Line 41:


For [[Eiger]] data processing, <code>H5ToXDS</code> should be installed as [[Eiger|explained]], and <code>h5dump</code> should be installed by e.g. <code>yum -y install hdf5</code>.
For [[Eiger]] data processing, <code>H5ToXDS</code> should be installed as [[Eiger|explained]], and <code>h5dump</code> should be installed by e.g. <code>yum -y install hdf5</code>.


== Mac OSX ==
== Mac OSX ==
Line 56: Line 57:
  echo you may have to "sudo su" first, to obtain administrator permissions!
  echo you may have to "sudo su" first, to obtain administrator permissions!
  cd /usr/local/bin
  cd /usr/local/bin
  curl -L -o - ftp://ftp.mpimf-heidelberg.mpg.de/pub/kabsch/XDS-OSX_64.tar.gz | tar xvf -
  curl -L -o - ftp://ftp.mpimf-heidelberg.mpg.de/pub/kabsch/XDS-OSX_64.tar.gz | tar xzvf -
  ln -sf XDS-OSX_64/* .
  ln -sf XDS-OSX_64/* .


Starting with macOS Catalina, you also need
xattr -dr XDS-OSX_64/*
if you get a security error popup (google "xattr com.apple.quarantine catalina").


=== other programs: [[XDS-Viewer]], [[XDSSTAT]], [[XDSCC12]], [[XDSGUI]], [[XSCALE_ISOCLUSTER]]  ===
=== other programs: [[XDS-Viewer]], [[XDSSTAT]], [[XDSCC12]], [[XDSGUI]], [[XSCALE_ISOCLUSTER]]  ===
... can be downloaded from ftp://turn5.biologie.uni-konstanz.de/pub/mac_bin/ . A simple way to obtain them is
... can be downloaded from https://{{SERVERNAME}}/pub/mac_bin/ . A simple way to obtain them is is to open a Terminal, and type:
  sudo su
  sudo su
which asks for the password and gives you administrator permissions. Then,
which asks for the password and gives you administrator permissions. Then,
  curl -O -R ftp://turn5.biologie.uni-konstanz.de/pub/mac_bin/get_folder.sh
# any folder would do; here we use /usr/local/bin/mac_bin
mkdir -p /usr/local/bin/mac_bin
cd /usr/local/bin/mac_bin
  curl -O -R https://{{SERVERNAME}}/pub/mac_bin/get_folder.sh
  chmod +x get_folder.sh
  chmod +x get_folder.sh
  ./get_folder.sh
  ./get_folder.sh
Then, using the Finder window which should have opened automagically, install XDSGUI and XDS-Viewer graphically, by pulling them into the Applications folder.  
If you want to update the programs some time later, just run these commands again.


In order to enable [[Eiger]] data processing, the <code>get_folder.sh</code> script  
In order to enable [[Eiger]] data processing, the <code>get_folder.sh</code> script  
# copies Dectris' Neggia library into /usr/local/lib64
# copies Dectris' Neggia library into /usr/local/lib64
# copies [[Eiger#General_aspects|eiger2cbf-osx]] into /usr/local/bin, but under the name <code>H5ToXds</code>.
# copies [[Eiger#General_aspects|eiger2cbf-osx]] into /usr/local/bin, but under the name <code>H5ToXds</code>
[[Generate_XDS.INP]] requires <code>h5dump</code> , and either you install this through [https://en.wikipedia.org/wiki/Homebrew_(package_management_software) homebrew]
# copies [https://support.hdfgroup.org/ftp/HDF5/releases/hdf5-1.8/hdf5-1.8.7/bin/mac-intel-x86_64/utilities/h5dump version 1.8.7] of <code>h5dump</code> into /usr/local/bin
brew install hdf5
or you install [http://phenix-online.org Phenix] in which case the <code>h5dump</code> provided by the Phenix package will be used by [[Generate_XDS.INP]].


Lastly, it is useful (for e.g. XDSGUI) to install <code>xxdiff</code> from http://furius.ca/downloads/xxdiff/releases/macosx/
Lastly, it is useful (for e.g. XDSGUI) to install <code>xxdiff</code> from http://furius.ca/downloads/xxdiff/releases/macosx/
Line 100: Line 105:
== Windows ==
== Windows ==


The programs of the [[XDS]] package as well as [[XDSGUI]], [[XDSSTAT]], [[XDSCC12]] and so on may be run on 64bit Windows 10 within the [http://www.pcworld.com/article/3050473/windows/heres-how-windows-10s-ubuntu-based-bash-shell-will-actually-work.html Linux Subsystem for Windows] (WSL). This (easily!) installs a Ubuntu 14.04.5 LTS environment, which supports the apt package manager, so in principle any software available for Ubuntu may be installed.
The programs of the [[XDS]] package as well as [[XDSGUI]], [[XDSSTAT]], [[XDSCC12]] and so on may be run on 64bit Windows 10 within the [https://docs.microsoft.com/windows/wsl/install-win10 Linux Subsystem for Windows] (WSL). This (easily!) installs a Ubuntu environment, which supports the apt package manager, so in principle any software available for Ubuntu may be installed (or other distros, see [https://blogs.msdn.microsoft.com/commandline/2017/05/11/new-distros-coming-to-bashwsl-via-windows-store/]).
[https://blogs.msdn.microsoft.com/commandline/2017/04/11/windows-10-creators-update-whats-new-in-bashwsl-windows-console/ Windows 10 Creators Update] (CU) allows to install (or update to) Ubuntu 16.04 (or other distros, see [https://blogs.msdn.microsoft.com/commandline/2017/05/11/new-distros-coming-to-bashwsl-via-windows-store/]), and fixes many bugs.


Graphical Linux programs require installation of a X server like [https://sourceforge.net/projects/xming/files/latest/download Xming] or [https://sourceforge.net/projects/vcxsrv VcXsvr] on the Windows host. There are helpful writeups (e.g. [http://asria.pl/configure-graphic-and-sound-for-wsl-creators-update-for-ubuntu-16-04],[http://wsl-guide.org/en/latest/]). To use the X server, one has to say in the shell window
Graphical Linux programs require installation of a X server like [https://sourceforge.net/projects/xming/files/latest/download Xming] or [https://sourceforge.net/projects/vcxsrv VcXsvr] on the Windows host. There are helpful writeups (e.g. [http://wsl-guide.org/en/latest/]). To use the X server, one has to say in the shell window
  export DISPLAY=:0
  export DISPLAY=:0
before running the program. Running XDSGUI under WSL's Ubuntu 14.04 requires installation of a few packages with
before running the program. Running XDSGUI under WSL's Ubuntu may require installation of a few packages with e.g.
  sudo apt-get install libgomp1 libqtgui4
  sudo apt-get install libgomp1 libqtgui4
and [[generate_XDS.INP]] requires a number of packages (some of which are only for specific detectors!); I'd start with
(see [[XDSGUI#Libraries_and_software_that_the_program_depends_on|XDSGUI]] and above).
 
[[generate_XDS.INP]] requires a number of packages (some of which are only for specific detectors!); I'd start with
  sudo apt-get install coreutils binutils gawk sed bc grep  
  sudo apt-get install coreutils binutils gawk sed bc grep  
and if required, also install python and hdf5-tools.
and if required, also install python and hdf5-tools.
The CU fixes many aspects of the interoperability between Windows and Linux, so is recommended. Without it, only single-processor xds runs smoothly, whereas the parallel xds_par stops with an error message.


XDSSTAT and the conversion to MTZ files by XDSCONV require a CCP4 installation accessible by WSL. In principle, CCP4 may be installed within WSL (have not tested this), or on the Windows host.
XDSSTAT and the conversion to MTZ files by XDSCONV require a CCP4 installation accessible by WSL. In principle, CCP4 may be installed within WSL (have not tested this), or on the Windows host.
Line 118: Line 122:


(Screenshot provided by Gustavo Lima)
(Screenshot provided by Gustavo Lima)
A detailed [https://strucbio.biologie.uni-konstanz.de/pub/xds%20%20prog%20installation%20in%20WSL%20(Lata%20Panicker).pdf writeup for Ubuntu 20.04 LTS] was provided by Dr Lata Panicker, SO(G), BARC, India.


== See also ==
== See also ==


[[Cluster Installation]]
[[Cluster Installation]]
2,652

edits

Cookies help us deliver our services. By using our services, you agree to our use of cookies.

Navigation menu