|
| 1 | +# The QuickView tool family at NERSC |
| 2 | + |
| 3 | +Our tools have been installed at NERSC, |
| 4 | +the National Energy Research Scientific Computing Center, |
| 5 | +and are continually updated there. |
| 6 | +Below are instructions for users who would like to use our installations. |
| 7 | + |
| 8 | +User's who would like to understand how our installation was done |
| 9 | +or how to have their own installation are referred to [this page](installation_at_nersc.md). |
| 10 | + |
| 11 | +## Quickstart for users familiar with JupyterHub |
| 12 | + |
| 13 | +- Login to [JupytherHub](https://jupyter.nersc.gov/hub/login) and start a terminal window. |
| 14 | +- Optional but recommended: in the terminal, use the `cd` command to go to the directory where your data files are located. |
| 15 | +- QuickView version 2 can be launched using the following command: |
| 16 | +``` |
| 17 | +/global/common/software/m4359/quickview2 |
| 18 | +``` |
| 19 | +- QuickCompare can be launched using the following command: |
| 20 | +``` |
| 21 | +/global/common/software/m4359/quickcompare |
| 22 | +``` |
| 23 | +- After a few seconds, the Terminal window will say "Use URL below to connect to the application:" |
| 24 | + and shows a URL starting with `https://`. |
| 25 | + A click on the URS will bring up the graphical UI in a brower window. |
| 26 | + |
| 27 | +::: tip Tip: Choosing a server for your analysis session |
| 28 | +JupyterHub's control panel allows users to choose from serveral different types of resources |
| 29 | +for their computing and analyais needs, including, e.g., login node, shared GPU node, |
| 30 | +exclusive nodes, etc. Since login nodes are shared by users and hence can get very busy |
| 31 | +or run into memory constraints, we recommend that users choose a shared GPU node |
| 32 | +or an exclusive node and user our tools there. |
| 33 | + |
| 34 | +Regardless of which type of node is chosen, the same commands (as listed above) |
| 35 | +are used to launch our tools in the QuickView family. |
| 36 | +::: |
| 37 | + |
| 38 | +## For NERSC user's who have not used JupyterHub |
| 39 | + |
| 40 | +Please visit [NERSC's Jupyter documentation](https://docs.nersc.gov/services/jupyter/) |
| 41 | +to learn how to use the JupyterHub service. |
| 42 | + |
| 43 | +## If you do not yet have any user account at NERSC |
| 44 | + |
| 45 | +Please visit [this page](https://docs.nersc.gov/accounts/#obtaining-an-account) |
| 46 | +to understand how to get started. |
0 commit comments