py4cytoscape.cytoscape_system.cytoscape_free_memory

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

Manually call Java’s garbage collection System.gc() to free up unused memory.

This process happens automatically, but may be useful to call explicitly for testing or evaluation purposes.

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

‘Unused memory freed up.’

Return type

str

Raises

  • CyError – if can’t free memory

  • requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error

Examples

>>> cytoscape_free_memory()
'Unused memory freed up.'