Voil=C3=A0 Apps on ARE (2024)

Voil=C3=A0 allows you to convert a Jupyter Notebook into an inte=ractive dashboard that allows you to share your work with others. It is sec=ure and customizable, giving you control over what your readers experience.=

Under ARE, the Voil=C3=A0 App allows you to start= a Voil=C3=A0instance dedicated for you=r use.

At this stage, you =need to join projectdk92 or up99 to accessVoil=C3=A0 Apps under ARE.

You can start a session to render an existing Jupyter notebook directly =as below:

1. Loginto ARE:https://are.nc=i.org.au/
2. Click the <=a href=3D"https://voila.readthedocs.io/en/stable/" class=3D"external-link" =rel=3D"nofollow">Voil=C3=A0 icon&n=bsp;on the Dashboard (home page)

3. Choose:

1. 1. the target Path to the notebook you want to open di=rectly.
   2. the number ofhours=span>you want your session to run for (maximum).
   3. the computequeueyou want to submit the job to.
   4. the size of thecompute resources=you have access to (maximum). If you attempt to ex=ceed the CPU limit your processes will be throttled to the amount requested=. If you exceed the memory, your Jupyter Kernel may be terminated. No=te: this is the resources used within the notebook; if you offload the proc=essing to other jobs (e.g. using Dask) then you may not need a very large J=upyterLab session.
   5. select whichproject<=/span>to allocate the SU from (must be a project with a current allocation,= or the session will not start).
   6. select whatstorage=span>(gdata and scratch areas) are required for your job to run.
   7. select additionalsoftware&=nbsp;licenses if required for your job.
   8. Module directories=: a space-separated list of addition=al directories to search for modulefile definitions. If these are under /g/=data or /scratch, make sure you've included the appropriate directive(s) in= your storage options above.
   9. Modules: a space-separated list of modules to be loade=d.
   10. Python or Conda virtual env=ironment base: specify the =top-level directory of a custom virtual env, or the base directory of a con=da environment. If this is under /g/data or /scratch, make sure you have in=cluded the appropriate directive in your storage options above.
   11. Conda environment<=span style=3D"letter-spacing: 0.0px;">: specify the name of a conda environ=ment to activate. You must supply a conda base directory in order for this =to work.
   12. if you want to receive anemail&=nbsp;once your session has st=arted, check the box before "I would like to receive an email when the session starts". This is useful when the cluster is busy and your session is =queued waiting for a free slot.

4. Additional settingsneeded for your= job in "Advanced Options..."

1. 1. Extra arguments provided to the Voil=C3=A0 command line.
   2. Environment variables to be defined.
   3. jobfs sizeallocated to your job.
   4. AdditionalPBS flagsnot covered by other options.
   5. Apre=-scriptto be run in your job before JupyterLab sta=rts.

5. Click "Launch" button to start a Voila session=.

6. Initially it wil=l show the status as Queued until your session begins to start.

Once it is finished= it will change to Running and look like the figure below:

7. Click theOpen Voila=span>button

8. This will open a new tab in your web browser that shows your rendered= Jupyter notebook. It will execute all notebook cells.

The rendered Notebook will now displayed in the web browser:

9. If you close this window, your Voil=C3==A0 session will continue running. To end your session, you c=an either Shutdown (last item in File menu) or delete the job on the Intera=ctive Sessions page of ARE.

Just put "/" in the targetPath to notebook field =and keep all other options the same with above.

After clicking the Open Voila button in Step #8, you wi=ll enter the file explorer from the root directory "/".

Navigate to your target notebook and click it to open.

You will be brought to your rendered dashboard.

You can use the file explorer to open another notebook and view its conv=erted dashboard in a new tab of your web browser.