higlass-python icon indicating copy to clipboard operation
higlass-python copied to clipboard

docs v2: Remote Jupyter Notebook section

Open manzt opened this issue 2 years ago • 2 comments
trafficstars

From prior docs:

Remote Jupyter Notebook
--------------------------

If your Jupyter notebook is running on a remote server (at e.g. `REMOTE_IP`), you’ll need to make sure that you have an extra port (let’s call it ``HG_PORT) open on your firewall that HiGlass can use to communicate with its server. That port will then need to be passed to the server display command:

.. code-block:: python
		higlass.display(
		    ...,
		    server_port=HG_PORT,
		    host=REMOTE_IP,
		    fuse=False
		)


The `fuse=False` option is often necessary if there is no support for `FUSE`. `FUSE` is only necessary for loading remote http datasets which are not hosted on a HiGlass server.

manzt avatar Feb 21 '23 19:02 manzt

I'm compiling a list of TODOs for the new documentation. The hg API should support most of these features, but I think that something like the FUSE API should be documented in it's own section.

manzt avatar Feb 21 '23 19:02 manzt

TODO: document the enable_proxy feature.

nvictus avatar Jul 19 '23 15:07 nvictus