OOMMF

Description

From OOMMF Documentation: OOMMF is a project in the Applied and Computational Mathematics Division (ACMD) of ITL / NIST, in close cooperation with µMAG, aimed at developing portable, extensible public domain programs and tools for micromagnetics. This code forms a completely functional micromagnetics package, with the additional capability to be extended by other programmers so that people developing new code can build on the OOMMF foundation.

Version

  • 1.2b0

Authorized Users

  • CIRCE account holders
  • RRA account holders
  • SC account holders

Platforms

  • CIRCE cluster
  • RRA cluster
  • SC cluster

Modules

OOMMF requires the following module file to run:

  • apps/oommf/1.2b0

Running OOMMF on CIRCE/SC

The OOMMF user guide is essential to understanding the application and making the most of it. The guide and this page should help you to get started with your simulations. Please refer to the Documentation section for a link to the guide.

  • Note on CIRCE: Make sure to run your jobs from your $WORK directory!
  • Note: Scripts are provided as examples only. Your SLURM executables, tools, and options may vary from the example below. For help on submitting jobs to the queue, see our SLURM User’s Guide.

Jobs Shorter than 30 Minutes in Length

Establishing a GUI connection to CIRCE/SC

To use OOMMF, you will need to connect to CIRCE/SC with GUI redirection, either using:

  • CIRCE/SC Desktop Environment
  • SSH with X11 redirection
    • If connecting from OSX or Linux via SSH, please ensure that you use one of the following commands to properly redirect X11:
      • [user@localhost ~]$ ssh -X circe.rc.usf.edu
        or
      • [user@localhost ~]$ ssh -X sc.rc.usf.edu

Once connected to CIRCE, you can open OOMMF using the steps below:

[user@login0 ~]$ module add apps/oommf/1.2b0
[user@login0 ~]$ oommf.tcl
  • Please Note: Interactive OOMMF processing/simulation jobs lasting more than 30 minutes should be run in an SRUN session, and NOT on the login nodes!

Jobs Longer than 30 Minutes in Length.

Establishing a GUI connection to CIRCE/SC

To use OOMMF, you will need to connect to CIRCE/SC with GUI redirection, either using:

  • CIRCE/SC Desktop Environment
  • SSH with X11 redirection
    • If connecting from OSX or Linux via SSH, please ensure that you use one of the following commands to properly redirect X11:
      • [user@localhost ~]$ ssh -X circe.rc.usf.edu
        or
      • [user@localhost ~]$ ssh -X sc.rc.usf.edu

1. After connecting to CIRCE, start an interactive SRUN session by running the command below with example resources:

[user@login0 ~]$ srun --time=02:00:00 --nodes=1 --cpus-per-task=1 --pty /bin/bash

 
This will request an interactive session on a compute node, with 1 processor core, for a duration of 2 hours.
 

2. If all goes well, you should get dropped into an interactive shell on the execution host. You will now need to load the OOMMF module as described above and then start the OOMMF console:

[user@login0 ~]$ module add apps/oommf/1.1b2 
[user@login0 ~]$ oommf.tcl


3. Once you are finished, you can simply type “exit” at the linux command prompt to exit the SRUN session.

Documentation

Home Page, User Guides, and Manuals

Reporting Bugs

Report bugs with OOMMF to the IT Help Desk: rc-help@usf.edu