HPC/Support: Difference between revisions

From CNM Wiki
< HPC
Jump to navigation Jump to search
 
(18 intermediate revisions by the same user not shown)
Line 3: Line 3:


== Compose a support request for CNM HPC==
== Compose a support request for CNM HPC==
If your question is not answered in the FAQ, choose one of the following to get help:
If your question is not answered in the FAQ: <!-- , choose one of the following to get help: -->
* [https://argonne.service-now.com/self_service/request_detail.do?sysparm_document_key=sc_cat_item,4e37eb5b13199f0016ff33228144b036 '''Submit online''']  – Log in with your regular Argonne/Carbon username and password.
* [https://argonne.servicenowservices.com/sp?id=sc_cat_item&sys_id=4e37eb5b13199f0016ff33228144b036 '''Submit a support request''']  – Log in with your regular Argonne username and password (same as on Carbon).
* Send an email to [mailto:[email protected]?subject=CNM%20HPC%20issue '''[email protected]''']
* Choose a suitable Request Type and provide the details as shown in the next section.
<!-- * [mailto:[email protected]?subject=CNM%20HPC%20issue Send an email to [email protected]] -->


=== Required information ===
== Required information ==
* Choose an appropriate '''subject line''', preferably after you typed and reviewed the body of your message.
<!-- *: Do not merely hit "Reply" on a previous unrelated message - doing so might cause your request to get overlooked in a previous thread. -->
*: Do not merely hit "Reply" on a previous unrelated message - doing so might cause your request to get overlooked in a previous thread.
Be as ''specific as possible'' in your free-form description or form input fields.
* Be as ''specific as possible'' in the body of your message. Include the following:
 
** The '''command''' you were trying to run or the menu item you chose in a graphical user interface
=== For all issues – local and remote ===
** The '''exact error message''' you get. Copy & Paste the message text, or take a screenshot and attach it to your mail.
Provide the following:
** The '''directory path''' and '''file name''' you were working on, if applicable.
* The '''command''' you were trying to run or the menu item you chose in a graphical user interface
**: It is generally not necessary to include in your message copies of files that already reside on Carbon.
* The <font color="red">'''exact error message'''</font> you get. Copy & Paste the message text, or take a screenshot and attach it to your mail.
* The '''directory path''' and '''file name''' you were working on, if applicable.
*: It is generally not necessary to include in your message copies of files that already reside on Carbon.
* Did the same command or action '''work previously''', if ever?
* Which '''changes''', if any, did you make to your configuration or input files since the last time this worked?
* Fill in an appropriate email '''Subject''' or form '''Title'''.
*: Best do this ''after'' you typed and reviewed the main text of your request.


=== For issues with PBS jobs ===
=== For issues with PBS jobs ===
For questions about PBS jobs, provide:
In addition to the [[#For all issues|preceding section]], for questions concerning PBS jobs, provide:
* the '''working directory''' of the job
* the '''working directory''' of the job
* the name of the '''job file''' used
* the name of the '''job file''' used
* the '''job number''' (for queued or running jobs)
* the '''job number''' (for queued or running jobs)


=== Additions required for remote access issues ===
=== For remote access ===
When you cannot log in to mega or a ''Carbon'' login node, provide the following:
When you cannot log in to mega or a ''Carbon'' login node, provide:
* The details in section [[#For all issues]],
plus the following:
* The '''hostname''' you ran the command on. It is often shown in the command prompt. (If the prompt shows <code>localhost</code> it is not specific enough – ask your local support person for help.)
* The '''hostname''' you ran the command on. It is often shown in the command prompt. (If the prompt shows <code>localhost</code> it is not specific enough – ask your local support person for help.)
* The '''hostname''' you're trying to ''reach.''
* The '''hostname''' you're trying to ''reach.''
Line 36: Line 45:
</source>
</source>
: Copy and Paste the possibly multi-page output into your request.
: Copy and Paste the possibly multi-page output into your request.
<!--
=== Review ===
* Make sure you included the ''error message'' that prompted your request.
* Review and if needed edit the '''Subject''' to match your question. <!--  (A simple reply to an unrelated system announcement may get ignored.)
* Submit.
//-->


=== Test directory ===
=== Test directory ===
We may ask you to prepare a ''test directory'' which has to contain ''only'' files required by your application for a standalone run or a single PBS job.
We may ask you to prepare a ''test directory'', which should help to:
This will help to diagnose your problem and confirm resolution, especially to diagnose subtle errors that are difficult to reproduce, such as where your application runs but does not fail outright.
* Reproduce your problem.
* Diagnose your problem, especially when errors are subtle or difficult to reproduce, such as where your application runs but does not fail outright.
* Confirm resolution.


Prepare the test directory at the same directory level as your troubled runs, and include:
Prepare the test directory so that it contains ''only'' files to run your application, either interactively or in a single PBS job, and possibly a file with correct output.
* the PBS job file,
; Preferred location:
* input files,
* In or under a ''sibling'' directory of one of a your failed runs (as opposed to a ''child'' directory).
* any local data files.
; Include:
* If available, add a file with the ''expected'' (correct) output, but with a file name that's different from the one generated by the job, such as by adding <code>.ref</code>.
* PBS job file, if applicable,
* Run-specific data and script files (files named in input data or hardcoded in the code, possibly as symbolic links),
* If available, a file with the ''expected'' (correct) output, but with a file name different from the one generated by the job, such as by adding <code>.ref</code>.


=== Review ===
In the course of diagnostics, we will suitably duplicate your directory as needed.
* Make sure you included the ''error message'' that prompted your request.
* If you chose to submit by email, review and if needed edit your '''Subject line''' to match your question. (A simple reply to an unrelated system announcement may get ignored.)
* Push the Submit button.


== Receiving support ==
== Receiving support ==

Latest revision as of 16:57, January 5, 2022

Review the FAQ list

For frequently asked questions regarding the Carbon HPC system, review Frequently Asked Questions to find answers.

Compose a support request for CNM HPC

If your question is not answered in the FAQ:

  • Submit a support request – Log in with your regular Argonne username and password (same as on Carbon).
  • Choose a suitable Request Type and provide the details as shown in the next section.

Required information

Be as specific as possible in your free-form description or form input fields.

For all issues – local and remote

Provide the following:

  • The command you were trying to run or the menu item you chose in a graphical user interface
  • The exact error message you get. Copy & Paste the message text, or take a screenshot and attach it to your mail.
  • The directory path and file name you were working on, if applicable.
    It is generally not necessary to include in your message copies of files that already reside on Carbon.
  • Did the same command or action work previously, if ever?
  • Which changes, if any, did you make to your configuration or input files since the last time this worked?
  • Fill in an appropriate email Subject or form Title.
    Best do this after you typed and reviewed the main text of your request.

For issues with PBS jobs

In addition to the preceding section, for questions concerning PBS jobs, provide:

  • the working directory of the job
  • the name of the job file used
  • the job number (for queued or running jobs)

For remote access

When you cannot log in to mega or a Carbon login node, provide:

plus the following:

  • The hostname you ran the command on. It is often shown in the command prompt. (If the prompt shows localhost it is not specific enough – ask your local support person for help.)
  • The hostname you're trying to reach.
  • The username you use to connect.
  • The software name and version you use to connect (e.g. SSH, VNC, or a browser).
  • Your operating system and version.

If you use ssh or scp, repeat your command in verbose mode by supplying the "-v" option twice: 

scp -v -v [… other options and arguments …]
ssh -v -v [… other options and arguments …]
Copy and Paste the possibly multi-page output into your request.


Test directory

We may ask you to prepare a test directory, which should help to:

  • Reproduce your problem.
  • Diagnose your problem, especially when errors are subtle or difficult to reproduce, such as where your application runs but does not fail outright.
  • Confirm resolution.

Prepare the test directory so that it contains only files to run your application, either interactively or in a single PBS job, and possibly a file with correct output.

Preferred location
  • In or under a sibling directory of one of a your failed runs (as opposed to a child directory).
Include
  • PBS job file, if applicable,
  • Run-specific data and script files (files named in input data or hardcoded in the code, possibly as symbolic links),
  • If available, a file with the expected (correct) output, but with a file name different from the one generated by the job, such as by adding .ref.

In the course of diagnostics, we will suitably duplicate your directory as needed.

Receiving support

When you get our support response:

  • Carefully read it.
  • Follow all instructions and answer all questions.
  • For account- and password-related issues: it may take several hours for changes to take effect. If your initial attempt fails, wait at least that long before retrying.

Additional considerations

To help us diagnose a problem:

Retrieved from "https://wiki.anl.gov/wiki_cnm/index.php?title=HPC/Support&oldid=7080"