Difference between revisions of "Getting Help"

(8 intermediate revisions by one other user not shown)
Line 1: Line 1:
  
 
+
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  
 
== CMS help ==
 
== CMS help ==
Line 27: Line 18:
  
 
The CWS help desk is the preferred contact method as it allows the CMS team to prioritize queries so as to set aside time for other CMS duties, provides transparency of open requests to all CMS team members , and gives the CMS team flexibility to cover for team absences. Simply outline your issue in an email to '''<span style="color:#16a085;">cws_help@nci.org.au</span>''' to open a ticket on our helpdesk.
 
The CWS help desk is the preferred contact method as it allows the CMS team to prioritize queries so as to set aside time for other CMS duties, provides transparency of open requests to all CMS team members , and gives the CMS team flexibility to cover for team absences. Simply outline your issue in an email to '''<span style="color:#16a085;">cws_help@nci.org.au</span>''' to open a ticket on our helpdesk.
 
'''Note: '''We have [[Updated_support_level|updated our user support levels]] due to current staff shortage issues.
 
 
 
 
 
 
  
 
== Guidelines for help requests ==
 
== Guidelines for help requests ==
Line 45: Line 29:
 
'''When seeking assistance''':
 
'''When seeking assistance''':
  
*Reduce'''&nbsp;'''your query if possible to a minimal reproducible example '''('''Stack Overflow has a'''[https://stackoverflow.com/help/minimal-reproducible-example nice description of what this means])'''  
+
*Reduce'''&nbsp;'''your query if possible to a minimal reproducible example '''('''Stack Overflow has a&nbsp;'''[https://stackoverflow.com/help/minimal-reproducible-example nice description of what this means])'''  
 
*Submit separate help requests for significantly new queries instead of appending to existing tickets  
 
*Submit separate help requests for significantly new queries instead of appending to existing tickets  
*Ensure required directories and/or files&nbsp;<meta charset="utf-8"></meta>'''[http://climate-cms.wikis.unsw.edu.au/Tips:_Custom_file_permissions_at_creation have group permissions]&nbsp;'''that make them accessible to us. For example, NCI /home directories by default are not, so you will need to change their permissions, but typically we can access the NCI /scratch and /g/data for your group  
+
*Ensure required directories and/or files&nbsp;'''[http://climate-cms.wikis.unsw.edu.au/Tips:_Custom_file_permissions_at_creation have group permissions]&nbsp;'''that make them accessible to us. For example, NCI /home directories by default are not, so you will need to change their permissions, but typically we can access the NCI /scratch and /g/data for your group  
 
*Include all relevant information in your help request:  
 
*Include all relevant information in your help request:  
*
+
**If a script/command generates an error, provide an exact reproduction of the script/command typed and error message  
**If a script/command generates an error, provide an exact reproduction of the script/command typed and error message  
+
**What have you tried so far to troubleshoot  
*
+
**Background info about your task (as we might be able to suggest instead a different approach) with links to any references invoked in your request  
**What have you tried so far to troubleshoot  
+
**Platform used for your task (e.g., your machine/OS, NCI Gadi, OOD, accessdev). If NCI, supply your username, and if Gadi indicate if the issue was in a login session or the PBS compute nodes  
*
+
**Specify any environment variables set and modules loaded, and if loaded in your .bashrc or .bash_profile files (not recommended). For errors with the conda environment we support, include the environment version.&nbsp;  
**Background info about your task (as we might be able to suggest instead a different approach) with links to any references invoked in your request  
+
**Upload any required code to '''[https://gist.github.com/ gist.github.com]&nbsp;'''or '''[https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/create-a-repo create a GitHub repository]&nbsp;'''for more complex examples. If barred by licensing issues, put it on NCI and provide the path. Never send copies of your code.   
*
+
*Do not send code or error messages as screenshots or poorly formatted text  
**Platform used for your task (e.g., your machine/OS, NCI Gadi, OOD, accessdev). If NCI, supply your username, and if Gadi indicate if the issue was in a login session or the PBS compute nodes  
 
*
 
**Specify any environment variables set and modules loaded, and if loaded in your .bashrc or .bash_profile files (not recommended). For errors with the conda environment we support, include the environment version.&nbsp;  
 
*
 
**Upload any required code to <meta charset="utf-8"></meta>'''[https://gist.github.com/ gist.github.com]&nbsp;'''or <meta charset="utf-8"></meta>'''[https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/create-a-repo create a GitHub repository]&nbsp;'''for more complex examples. If barred by licensing issues, put it on NCI and provide the path. Never send copies of your code.   
 
*Do not send code or error messages as screenshots or poorly formatted text
 
 
 
== What can users expect ==
 
 
 
Users can expect:
 
  
*to receive a reply to a query within 24 hours during normal business hours
+
'''After seeking assistance''':
*have their problem solved if it is within scope, or a work-around suggested, and if not then an explanation of why their problem is currently not solvable
 
*where an update is required for a current ticket to&nbsp;wait no longer than a week during a non-holiday period
 
  
If any of the above expectations are not being met, contact the CMS team. We are only human and sometimes might inadvertently let slip some requests.
+
*You should receive a reply to your query within 24 hours during normal business hours
 +
*We will provide a solution to your problem (if within scope), or a work-around, or an explanation for why it is currently unsolvable
 +
*You should expect updates required for current tickets to take at most a week during non-holiday periods
 +
*Consider if you need some '''[http://climate-cms.wikis.unsw.edu.au/Training training] '''to improve your skills
  
== Resources ==
+
If any of the above expectations are not being met, please contact the CMS team.
  
Blog post on [https://codeblog.jonskeet.uk/2010/08/29/writing-the-perfect-question/ Writing the perfect question] &nbsp;
+
&nbsp;
  
&nbsp; &nbsp;
+
&nbsp;

Revision as of 19:02, 23 November 2022

 

CMS help

The CMS team supports CLEX members with computational issues: 

  • Running Models: we support several models (see navigation bar on the left) and assist with others, subject to limitations of scope and team resources. 
  • Data Analysis: we assist with analysis and general computing tasks on NCI machines, and offer only limited support on other sites or home machines as we possess neither control over nor familiarity with such systems.
  • Data Access and publishing: we offer assistance in publishing data and accessing climate data available at NCI.

The CMS team can be contacted for support through: 

The CWS help desk is the preferred contact method as it allows the CMS team to prioritize queries so as to set aside time for other CMS duties, provides transparency of open requests to all CMS team members , and gives the CMS team flexibility to cover for team absences. Simply outline your issue in an email to cws_help@nci.org.au to open a ticket on our helpdesk.

Guidelines for help requests

Before seeking assistance:

When seeking assistance:

  • Reduce your query if possible to a minimal reproducible example (Stack Overflow has a nice description of what this means)
  • Submit separate help requests for significantly new queries instead of appending to existing tickets
  • Ensure required directories and/or files have group permissions that make them accessible to us. For example, NCI /home directories by default are not, so you will need to change their permissions, but typically we can access the NCI /scratch and /g/data for your group
  • Include all relevant information in your help request:
    • If a script/command generates an error, provide an exact reproduction of the script/command typed and error message
    • What have you tried so far to troubleshoot
    • Background info about your task (as we might be able to suggest instead a different approach) with links to any references invoked in your request
    • Platform used for your task (e.g., your machine/OS, NCI Gadi, OOD, accessdev). If NCI, supply your username, and if Gadi indicate if the issue was in a login session or the PBS compute nodes
    • Specify any environment variables set and modules loaded, and if loaded in your .bashrc or .bash_profile files (not recommended). For errors with the conda environment we support, include the environment version. 
    • Upload any required code to gist.github.com or create a GitHub repository for more complex examples. If barred by licensing issues, put it on NCI and provide the path. Never send copies of your code.
  • Do not send code or error messages as screenshots or poorly formatted text

After seeking assistance:

  • You should receive a reply to your query within 24 hours during normal business hours
  • We will provide a solution to your problem (if within scope), or a work-around, or an explanation for why it is currently unsolvable
  • You should expect updates required for current tickets to take at most a week during non-holiday periods
  • Consider if you need some training to improve your skills

If any of the above expectations are not being met, please contact the CMS team.