Skip to content

Commit

Permalink
Update cylc8.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aosprey authored Oct 10, 2024
1 parent ff5f54e commit bf6bbe5
Showing 1 changed file with 2 additions and 34 deletions.
36 changes: 2 additions & 34 deletions pages/cylc8.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Report any issues to the helpdesk.

Cylc 8 replaces the Python 2 based Cylc 7 software.
It is a complete rewrite in Python 3 and contains many changes from Cylc 7, so we encourage you to look at the documentation.
The user interface system is still being developed and does not yet have full functionality.

Useful links:
* [Cylc 8 documentation](https://cylc.github.io/cylc-doc/stable/html/index.html)
Expand All @@ -37,6 +36,8 @@ Useful links:

Note that in Cylc 8 terminology "suites" have become "workflows".

We are working on deploying the web-based GUI on puma2.

</div><!-- /.medium-8.columns -->
</div><!-- /.row -->

Expand Down Expand Up @@ -112,36 +113,3 @@ On PUMA2 the following platforms are available:
Note that multiplexing is no longer needed to submit jobs to Jasmin. There are still some issues if a host is not available or not fully functional. We have not yet set up support for the new Jasmin servers.

You can test submission to each of the platforms with the workflow u-dj398.

### Using the web-based UI with port-forwarding

Copying the instructions documented [here](https://cylc.discourse.group/t/unclear-on-how-cylc-8-components-work-together/787/2)

> First open an ssh tunnel, so that a given port on your local machine (e.g. your laptop) maps to the Cylc UI Server’s port on the HPC. On your local machine, type
> ```
> $ ssh -N -L PORT:localhost:PORT HOST
> ```
> where PORT is a valid port number and HOST is on the HPC. You will need to know the range of allowed ports (e.g.1024-49151). Choose any number in this range but make sure your port number is fairly unique to avoid clashing with other users. (Note the option -N opens the connection without logging you into the shell).
>
> Then ssh to the host:
> ```
> $ ssh HOST
> ```
> and add the following to $HOME/.cylc/uiserver/jupyter_config.py on the HOST.
> ```
> c.ServerApp.open_browser=False
> c.ServerApp.port=PORT
> ```
> where PORT and HOST match the values you selected when opening the ssh tunnel.
>
> You’re now ready to fire up the web graphical interface
> ```
> $ cylc gui
> ```
> Just copy the URL that looks like
> ```
> http://127.0.0.1:PORT/cylc?token=TOKEN
> ```
> into your web browser. (Again substitute HOST and PORT with the values chosen above.)
Note that each user needs a unique port number.

0 comments on commit bf6bbe5

Please sign in to comment.