py4cytoscape.cytoscape_system.cytoscape_memory_status

cytoscape_memory_status(base_url='http://127.0.0.1:1234/v1')[source]

Returns the memory resources of the server running Cytoscape.

Parameters: base_url (str) – Ignore unless you need to specify a custom domain, port or version to connect to the CyREST API. Default is http://localhost:1234 and the latest version of the CyREST API supported by this version of py4cytoscape.
Returns: {‘usedMemory’: <mem>, ‘freeMemory’: <mem>, ‘totalMemory’: <mem>, ‘maxMemory’: <mem>} where <mem> is a count of megabytes
Return type: dict
Raises: requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error

Examples

>>> cytoscape_memory_status()
{'usedMemory': 160, 'freeMemory': 1819, 'totalMemory': 1979, 'maxMemory': 5510}