Difference between revisions of "Connecting To CIRCE"

 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Accounts ==
== Accounts ==


Under Development!
'''Please note:''' CIRCE is for research-related use only.
 
To request an account on CIRCE, please send an email (from your official USF email address) to {{rchelp}} with the subject "CIRCE Account Request". In this email, please also provide the following info:
 
* '''Faculty Sponsor Full Name:'''
* '''Faculty Sponsor Department:'''
* '''Faculty Sponsor USF Email Address:'''


== Connecting & Accessing ==
== Connecting & Accessing ==


To connect to CIRCE, you will need to use an SSH client or utilize the [[CIRCE/SC Desktop|CIRCE/SC Desktop Environment]]. The following information will be needed to connect:
To connect to CIRCE, you will need to use an SSH client or utilize the [[CIRCE_Desktop_Environment|CIRCE Desktop Environment]].  
 
=== Connecting via SSH ===
 
The following information will be needed to connect via SSH:


* Your USF NetID and Password
* Your USF NetID and Password
Line 11: Line 21:
* '''SSH Port:''' '''22''' (This is the default)
* '''SSH Port:''' '''22''' (This is the default)


If you wish to use shell access via SSH, here are some popular SSH clients for Windows:
==== SSH clients for Windows ====


* PuTTY: http://www.chiark.greenend.org.uk/~sgtatham/putty/
* PuTTY: https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html
** '''Note''': PuTTY is the ''recommended'' client to use when connecting to CIRCE. IT staff will provide full support for users utilizing this connection method, however, graphical (X11) connections are not provided.
** '''Note''': PuTTY is the ''recommended'' client to use when connecting to CIRCE. IT staff will provide full support for users utilizing this connection method, however, graphical (X11) connections are not provided.
* Cygwin (Includes OpenSSH): http://www.cygwin.com/  
* Cygwin (Includes OpenSSH): http://www.cygwin.com/  
** '''Note''': Cygwin is for ''advanced'' users who are familiar with using a UNIX/Linux environment! We can only provide limited support for this method… So be warned!
** '''Note''': Cygwin is for ''advanced'' users who are familiar with using a UNIX/Linux environment! We can only provide limited support for this method… So be warned!


Most other platforms such as Linux or Mac OSX include a version of OpenSSH by default. Documentation for OpenSSH is here: http://www.openssh.com/
==== SSH clients use on Mac OSX and Linux ====


Both Mac and Linux user can take advantage of X2Go as well. Clients for both operating systems can be found here: http://wiki.x2go.org/doku.php/doc:installation:x2goclient
* OSX SSH Tutorial
** http://osxdaily.com/2017/04/28/howto-ssh-client-mac/
* Linux SSH Tutorial
** https://acloudguru.com/blog/engineering/ssh-and-scp-howto-tips-tricks


'''''' '''Note''': Please read and understand all instructions related to your OS before getting started.
=== Connecting via X2Go ===


You will probably be interested in transferring files to and from CIRCE. Please see our [[CIRCE Data Access|guide to accessing data on CIRCE]] for more information
Windows, Mac, and Linux users can take advantage of X2Go as well to connect to CIRCE via the [[CIRCE_Desktop_Environment|CIRCE Desktop Environment]].
 
'''Note''': Please read and understand all instructions related to your OS before getting started.


== Tutorials ==
== Accessing Data on CIRCE ==


If you are new to Linux or UNIX, you may wish to review some online tutorials. We’ve compiled a collection of tutorials that we think new users will find helpful. We highly recommend that if you are new to Linux/UNIX-based environments that you take the time to go through at least one of the tutorials. You can safely skip any sections related to installing Linux, unless you wish to do this on your own.
You will probably be interested in transferring files to and from CIRCE. Please see our [[CIRCE Data Access|guide to accessing data on CIRCE]] for more information


* Unix Tutorial for Beginners: http://faculty.smu.edu/reynolds/unixtut/
== Linux Tutorials ==
** Probably the gentlest and most comprehensive tutorial for users coming from Windows. Highly recommended.
* Unix/Linux Tutorial: http://www.guru99.com/unix-linux-tutorial.html
** This tutorial is geared towards users who will be running Linux locally, but its command-line lessons are useful whether you run it locally or not.
* Another Linux tutorial: http://linuxsurvival.com/index.php
* Shell Scripting Guide (extremely useful for automating repetitive tasks): http://www.freeos.com/guides/lsst/


Besides basic Linux knowledge, there are just a couple of important things you should be aware of while using the systems.
If you are new to Linux or UNIX, you may wish to review some online tutorials. We’ve [[Linux_Tutorials|compiled a collection of tutorials here]] that we think new users will find helpful. We highly recommend that if you are new to Linux/UNIX-based environments that you take the time to go through at least one of the tutorials. You can safely skip any sections related to installing Linux, unless you wish to do this on your own.


== Getting Work Done ==
== Getting Work Done ==


To start using Circe for productive work, see the following documents:
To start using CIRCE for productive work, see the following documents:


# [[Guide_to_SLURM|Guide to SLURM]] - This guide will provide all of the information you need to successfully use the SLURM job submission system on CIRCE.
# [[Guide_to_SLURM|Guide to SLURM]] - This guide will provide all of the information you need to successfully use the SLURM job submission system on CIRCE.

Latest revision as of 18:24, 3 September 2021

Accounts

Please note: CIRCE is for research-related use only.

To request an account on CIRCE, please send an email (from your official USF email address) to rc-help@usf.edu with the subject "CIRCE Account Request". In this email, please also provide the following info:

  • Faculty Sponsor Full Name:
  • Faculty Sponsor Department:
  • Faculty Sponsor USF Email Address:

Connecting & Accessing

To connect to CIRCE, you will need to use an SSH client or utilize the CIRCE Desktop Environment.

Connecting via SSH

The following information will be needed to connect via SSH:

  • Your USF NetID and Password
  • Hostname: circe.rc.usf.edu
  • SSH Port: 22 (This is the default)

SSH clients for Windows

  • PuTTY: https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html
    • Note: PuTTY is the recommended client to use when connecting to CIRCE. IT staff will provide full support for users utilizing this connection method, however, graphical (X11) connections are not provided.
  • Cygwin (Includes OpenSSH): http://www.cygwin.com/
    • Note: Cygwin is for advanced users who are familiar with using a UNIX/Linux environment! We can only provide limited support for this method… So be warned!

SSH clients use on Mac OSX and Linux

Connecting via X2Go

Windows, Mac, and Linux users can take advantage of X2Go as well to connect to CIRCE via the CIRCE Desktop Environment.

Note: Please read and understand all instructions related to your OS before getting started.

Accessing Data on CIRCE

You will probably be interested in transferring files to and from CIRCE. Please see our guide to accessing data on CIRCE for more information

Linux Tutorials

If you are new to Linux or UNIX, you may wish to review some online tutorials. We’ve compiled a collection of tutorials here that we think new users will find helpful. We highly recommend that if you are new to Linux/UNIX-based environments that you take the time to go through at least one of the tutorials. You can safely skip any sections related to installing Linux, unless you wish to do this on your own.

Getting Work Done

To start using CIRCE for productive work, see the following documents:

  1. Guide to SLURM - This guide will provide all of the information you need to successfully use the SLURM job submission system on CIRCE.
  2. Locate the documentation for your application on this list: Available Applications. If its not there, then we haven’t worked with it before. You can either compile and install it yourself, or contact us to have it done for you.
  3. Available Hardware - This page provides a breakdown of all the HPC hardware that is part of CIRCE. This is useful for referencing our resources or determining how best to compile or prepare your application.
  4. Environment Modules - Environment Modules give you access to applications and features on CIRCE. Taking the time to learn their use is essential for making the most of CIRCE.

Running Graphical Applications

In order to run graphical applications such as Comsol, Matlab, Mathematica, HFSS, etc., please see the documentation for the CIRCE/SC Desktop Environment environments.