Skip to content

oasys

Summary

Source: https://github.com/oasys-kit/OASYS1

License: GPL-3.0 https://github.com/oasys-kit/OASYS1/blob/master/LICENSE

Path: /software/OASYS/oasys-workshop/oasys

Documentation: https://www.aps.anl.gov/Science/Scientific-Software/OASYS

Related: srw

Using oasys

the run oasys open a terminal and run

module load maxwell OASYS/oasys-workshop

This will set the PATH so that you can run oasys directly from the terminal:

module load maxwell OASYS/oasys-workshop
oasys

Loading the module will also create an Oasys icon on your desktop when using a XFCE session via FastX. Just double-click the icon to start the application.

Note: if might take 30 seconds for oasys to show up, when running oasys for the first time on one of the display nodes (i.e. it's not cached yet)

Creating your own installation

you can easily install oasys yourself in an arbitrary location. But please don't use the official oasys-installation-script. Apart from avoidable sudo-statements, that one uses miniconda3 and essentially requires a paid license. The repository is blocked at DESY, so the script will simply fail in any case.

Our custom installer makes use of an existing miniforge-installation on Maxwell

/software/OASYS/oasys-workshop/installer/install_oasys.sh 

   Usage:  -p prefix [-d] [-h]

   -p|--prefix prefix      installation directory
   -d|--desktop            create an icon on the Desktop
   -h|--help               show usage

To install oasys in your home-directory and also create a custom desktop-icon:

/software/OASYS/oasys-workshop/installer/install_oasys.sh -p $HOME/OASYS -d

It will print a messages what it's doing, but that should be fairly self-explanatory. The installer will create a wrapper $HOME/OASYS/bin/oasys which launches oasys as

python -m oasys.canvas -l1 --no-update --force-discovery

when launching oasys for the first time, simply add the available add-ons, and possibly the ESRF-extensions and restart the application.

For development purposes you might need a full setup, e.g.

export PATH=/software/OASYS/miniforge/bin:$PATH
. mamba-init

export PYTHONNOUSERSITE=1
mamba activate <the prefix used for the installation>