Cytoscape Wiki|
Size: 8620
Comment: Added text about changing home directory
|
Size: 8772
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 19: | Line 19: |
| Cytoscape requires Java 7 or later. (While Cytoscape versions prior to v3.2 run on Java 6, Oracle and other JVM suppliers have dropped Java 6 support. Consequently, Cytoscape v3.2 and later don't support Java 6 either.) | '''Cytoscape requires Java 7 or later.''' |
| Line 21: | Line 21: |
| While Cytoscape runs with 32 bit Java versions, using a 64 bit Java allows the largest networks to be loaded and enables the fastest network processing. We recommend a 64 bit Java Runtime Environment (JRE). | * While Cytoscape versions prior to v3.2 run on Java 6, Oracle and other JVM suppliers have dropped Java 6 support. Consequently, Cytoscape v3.2 and later don't support Java 6 either. |
| Line 23: | Line 23: |
| While Cytoscape runs with Java 8, it is not extensively tested, and some App Store apps are known to fail. Though future versions of Cytoscape will be solidly compatible with Java 8, we currently recommend Java 7. The Java 7 Oracle distribution can be found at [[http://java.com/en/download/manual_java7.jsp |Java7 JRE]]. | * We recommend a 64 bit Java Runtime Environment (JRE). While Cytoscape runs with 32 bit Java versions, using a 64 bit Java allows the largest networks to be loaded and enables the fastest network processing. For Windows, the default JRE download provided at java.com is 32 bits regardless of the Windows version. While Cytoscape will run with a 32 bit JRE, it will be limited to loading only small networks. We recommend downloading and installing a 64 bit JRE. |
| Line 25: | Line 25: |
| Note: For Windows, the default JRE download provided at the popular java.com is 32 bits regardless of the Windows version. While Cytoscape will run with a 32 bit JRE, it will be limited to loading only small networks. We recommend downloading and installing a 64 bit JRE. | * We currently recommend Java 7 or Java 8. The Java 7 Oracle distribution can be found at [[http://java.com/en/download/manual_java7.jsp |Java7 JRE]]. |
| Line 34: | Line 34: |
| There are a number of options for downloading and installing Cytoscape. See the download page at the [[http://cytoscape.org]] website for all options. | There are a number of options for downloading and installing Cytoscape. See the download page at the [[http://cytoscape.org]] website for all options. |
| Line 51: | Line 51: |
| The ''{{{p/}}}'' directory signifies the program directory, which varies from platform to platform. | The ''{{{p/}}}'' directory signifies the program directory, which varies from platform to platform. For Cytoscape to work properly, all files should be left in the directory in which they were unpacked. The core Cytoscape application assumes this directory structure when looking for the various libraries needed to run the application. |
| Line 53: | Line 53: |
| The ''{{{u/}}}'' directory signifies the user's home directory, which varies from user to user and from platform to platform. To change the user home directory from the default, one can set the Java environment variable {{{user.home}}} to the desired directory. This can be done by adding the following option to the Cytoscape.vmoptions file or the _JAVA_OPTIONS environment variable, substituting the desired path as appropriate: | The ''{{{u/}}}'' directory signifies the user's home directory, which varies from user to user and from platform to platform. To change the user home directory from the default, one can set the Java environment variable {{{user.home}}} to the desired directory -- this is useful when Cytoscape is installed on a workstation, but the home directory is stored on a central file server. {{{user.home}}} can be set by adding the following option to the Cytoscape.vmoptions file or the _JAVA_OPTIONS environment variable, substituting the desired path as appropriate: |
| Line 57: | Line 57: |
| Your operating system may have other mechanisms for setting environment variables -- see your operating system documentation for further details. | |
| Line 58: | Line 59: |
|
For Cytoscape to work properly, all files should be left in the directory in which they were unpacked. The core Cytoscape application assumes this directory structure when looking for the various libraries needed to run the application. ==== A quick note on upgrading ==== If you have a previous installation you have two options: |
==== A quick note on upgrading your Cytoscape installation ==== If you have a previous Cytoscape installation you have two options: |
| Line 64: | Line 63: |
| 1. Just keep what you have and simply pick a distinct, new directory for installation. In the unlikely event that you should encounter any problem, delete the {{{.props}}} files in your {{{CytoscapeConfiguration}}} directory. If that doesn't help try deleting the {{{CytoscapeConfiguration}}} directory. This latter step will cause you to lose all of the apps that you have installed via the App Store, so only do that if you are having problems or if you don't mind reinstalling your apps. The core apps will not be affected by this step. | 1. Just keep what you have and simply pick a distinct, new directory for installation. In the unlikely event that you should encounter any problem, delete the {{{.props}}} files in your {{{CytoscapeConfiguration}}} directory. If that doesn't help try deleting the {{{CytoscapeConfiguration}}} directory. This latter step will cause you to lose all of the apps that you have installed via the App Store, so only do that if you are having problems or if you don't mind reinstalling your apps. The core apps will not be affected by this step. |
| Line 68: | Line 67: |
| As with any application: double-click on the icon created by the installer or by running {{{cytoscape.sh}}} from the command line (Linux or Mac OS X) or double-clicking {{{cytoscape.bat}}} or the Program Launch icon (Windows). | As with any application, launch Cytoscape by double-clicking on the icon created by the installer, by running {{{cytoscape.sh}}} from the command line (Linux or Mac OS X) or by double-clickinging {{{cytoscape.bat}}} or the Program Launch icon (Windows). |
| Line 77: | Line 76: |
| For most regular users, Cytoscape will estimate and reserve the proper amount of memory. An incorrect estimate may result in Cytoscape hanging at startup or Cytoscape unable to load your network. Unless Cytoscape fails to start or open your network, it has likely estimated the available memory correctly, and you can continue to the [[Cytoscape_User_Manual/Quick_Tour|Quick Tour]]. (If Cytoscape misjudges the memory size or can't allocate enough memory, it could be that you're running with a 32 bit JRE and could get better results by installing a 64 bit JRE -- see the Install Java section above.) | For most regular users, Cytoscape will estimate and reserve the proper amount of memory. An incorrect estimate may result in Cytoscape hanging at startup or Cytoscape unable to load your network. Unless Cytoscape fails to start or open your network, it has likely estimated the available memory correctly, and you can continue to the [[Cytoscape_User_Manual/Quick_Tour|Quick Tour]]. If Cytoscape misjudges the memory size or can't allocate enough memory, it could be that you're running with a 32 bit JRE and could get better results by installing a 64 bit JRE -- see the Install Java section above. |
| Line 83: | Line 82: |
| By default, Cytoscape uses an estimate for initial and maximum memory allocation based on your operating system, system architecture (32 or 64 bit), and installed memory. You can change Cytoscape's initial and/or maximum memory size by editing the Cytoscape.vmoptions file, which resides in the same directory as the Cytoscape executable. The file contains one option per line, with each line terminated by a linefeed, and an extra linefeed at the end of the file. (Note that for the MacOS platform, the situation is slightly different -- if you are launching Cytoscape by clicking on the Cytoscape icon, you must edit the .../Cytoscape.app/Contents/Info.plist file instead.) | By default, Cytoscape uses an estimate for initial and maximum memory allocation based on your operating system, system architecture (32 or 64 bit), and installed memory. You can change Cytoscape's initial and/or maximum memory size by editing the Cytoscape.vmoptions file, which resides in the same directory as the Cytoscape executable. The file contains one option per line, with each line terminated by a linefeed, and an extra linefeed at the end of the file. Note that for the MacOS platform, the situation is slightly different -- if you are launching Cytoscape by clicking on the Cytoscape icon, you must edit the .../Cytoscape.app/Contents/Info.plist file instead. |
| Line 92: | Line 91: |
| There is one more option related to memory allocation. Some of the functions in Cytoscape use larger stack space (a temporary memory for some operations, such as Layout). Since this value is set independently from the values above, sometimes Layout algorithms fails due to the ''out of memory'' error. To avoid this, you can set larger heap size for Cytoscape tasks by using the '''''taskStackSize''''' option in the {{{cytoscape3.props}}} file (located in the {{{CytoscapeConfiguration}}} directory). This can be edited within Cytoscape using the Preferences Editor (Edit-Preferences-Properties...) - look for taskStackSize. The value should be specified in bytes. | There is one more option related to memory allocation. Some of the functions in Cytoscape use larger stack space (a temporary memory for some operations, such as layout). Since this value is set independently from the values above, sometimes layout algorithms fail due to an ''out of memory'' error. To avoid this, you can set a larger heap size for Cytoscape tasks by using the '''''taskStackSize''''' option in the {{{cytoscape3.props}}} file (located in the {{{CytoscapeConfiguration}}} directory). This can be edited within Cytoscape using the Preferences Editor (Edit-Preferences-Properties...) - look for taskStackSize. The value should be specified in bytes. |
Cytoscape is a Java application verified to run on the Linux, Windows, and Mac OS X platforms. Although not officially supported, other UNIX platforms such as Solaris or FreeBSD may run Cytoscape if Java version 7 or later is available for the platform.
System requirements
The system requirements for Cytoscape depend on the size of the networks you want to load, view and manipulate.
Note that as of Cytoscape v3.2, networks are loaded faster and in less memory than with previous versions. While this is good news, networks created on v3.2 on a given memory configuration (e.g., 1GB) may not be loadable by prior Cytoscape versions on the same memory configuration.
|
Small Network Visualization |
Large Network Analysis/Visualization |
Processor |
1GHz |
As fast as possible, with multiple cores |
Memory |
512MB |
2GB+ |
Graphics Card |
Integrated video |
High-end graphics Card |
Monitor |
XGA (1024X768) |
Wide or Dual Monitor |
Specific system requirements, limitations, and configuration options apply to each platform, as described in the Release Notes available on the http://cytoscape.org website.
Getting Started
Install Java
Cytoscape requires Java 7 or later.
- While Cytoscape versions prior to v3.2 run on Java 6, Oracle and other JVM suppliers have dropped Java 6 support. Consequently, Cytoscape v3.2 and later don't support Java 6 either.
- We recommend a 64 bit Java Runtime Environment (JRE). While Cytoscape runs with 32 bit Java versions, using a 64 bit Java allows the largest networks to be loaded and enables the fastest network processing. For Windows, the default JRE download provided at java.com is 32 bits regardless of the Windows version. While Cytoscape will run with a 32 bit JRE, it will be limited to loading only small networks. We recommend downloading and installing a 64 bit JRE.
We currently recommend Java 7 or Java 8. The Java 7 Oracle distribution can be found at Java7 JRE.
For additional information, select the Release Notes button on the Cytoscape web site (http://cytoscape.org).
Install Cytoscape
Downloading and installing
There are a number of options for downloading and installing Cytoscape. See the download page at the http://cytoscape.org website for all options.
- Automatic installation packages exist for Windows, Mac OS X, and Linux platforms -- best for most users.
- You can install Cytoscape from a compressed archive distribution.
- You can build Cytoscape from the source code.
You can check out the latest and greatest software from our Git repository.
Cytoscape installations (regardless of platform) containing the following files and directories:
File/Directory |
Description |
p/Cytoscape_v3.2.0 |
Cytoscape program files, startup scripts, and default location for session files |
p/Cytoscape_v3.2.0/Cytoscape.vmoptions |
Cytoscape memory configuration settings |
p/Cytoscape_v3.2.0/sampleData |
Preset networks as described in the embedded README.txt file |
p/Cytoscape_v3.2.0/framework |
Cytoscape program files |
u/CytoscapeConfiguration |
Cytoscape properties and program cache files |
u/CytoscapeConfiguration/cytoscape3.props |
Cytoscape configuration settings |
The p/ directory signifies the program directory, which varies from platform to platform. For Cytoscape to work properly, all files should be left in the directory in which they were unpacked. The core Cytoscape application assumes this directory structure when looking for the various libraries needed to run the application.
The u/ directory signifies the user's home directory, which varies from user to user and from platform to platform. To change the user home directory from the default, one can set the Java environment variable user.home to the desired directory -- this is useful when Cytoscape is installed on a workstation, but the home directory is stored on a central file server. user.home can be set by adding the following option to the Cytoscape.vmoptions file or the _JAVA_OPTIONS environment variable, substituting the desired path as appropriate:
-Duser.home=/path/to/desired/home
Your operating system may have other mechanisms for setting environment variables -- see your operating system documentation for further details.
A quick note on upgrading your Cytoscape installation
If you have a previous Cytoscape installation you have two options:
Starting with a clean slate. For this you should delete your previous installation directory and the CytoscapeConfiguration directory (see below for the location of this directory).
Just keep what you have and simply pick a distinct, new directory for installation. In the unlikely event that you should encounter any problem, delete the .props files in your CytoscapeConfiguration directory. If that doesn't help try deleting the CytoscapeConfiguration directory. This latter step will cause you to lose all of the apps that you have installed via the App Store, so only do that if you are having problems or if you don't mind reinstalling your apps. The core apps will not be affected by this step.
Launch the application
As with any application, launch Cytoscape by double-clicking on the icon created by the installer, by running cytoscape.sh from the command line (Linux or Mac OS X) or by double-clickinging cytoscape.bat or the Program Launch icon (Windows).
After launching Cytoscape a window will appear that looks like this:
If your Cytoscape window does not resemble this, further configuration may be required. Consult the Release Notes available on the http://cytoscape.org website.
Note on Memory Consumption
For most regular users, Cytoscape will estimate and reserve the proper amount of memory. An incorrect estimate may result in Cytoscape hanging at startup or Cytoscape unable to load your network. Unless Cytoscape fails to start or open your network, it has likely estimated the available memory correctly, and you can continue to the Quick Tour. If Cytoscape misjudges the memory size or can't allocate enough memory, it could be that you're running with a 32 bit JRE and could get better results by installing a 64 bit JRE -- see the Install Java section above.
When Cytoscape starts, it displays the current memory usage in the lower right corner of the main interface. You can click on the Memory button at any time to access an option to Free Unused Memory. While most users won't need to use this option, it can be useful for users who have multiple large networks loaded.
Overall Memory Size for Cytoscape
By default, Cytoscape uses an estimate for initial and maximum memory allocation based on your operating system, system architecture (32 or 64 bit), and installed memory. You can change Cytoscape's initial and/or maximum memory size by editing the Cytoscape.vmoptions file, which resides in the same directory as the Cytoscape executable. The file contains one option per line, with each line terminated by a linefeed, and an extra linefeed at the end of the file. Note that for the MacOS platform, the situation is slightly different -- if you are launching Cytoscape by clicking on the Cytoscape icon, you must edit the .../Cytoscape.app/Contents/Info.plist file instead.
For example, if you want Cytoscape to initially allocate 2GB of memory and use up to a maximum of 4GB, edit the Cytoscape.vmoptions file to contain the following lines (... do not forget the linefeed at the end of each line, and an extra linefeed at the end of the file!):
-Xms2GB
-Xmx4GB
Stack Size
There is one more option related to memory allocation. Some of the functions in Cytoscape use larger stack space (a temporary memory for some operations, such as layout). Since this value is set independently from the values above, sometimes layout algorithms fail due to an out of memory error. To avoid this, you can set a larger heap size for Cytoscape tasks by using the taskStackSize option in the cytoscape3.props file (located in the CytoscapeConfiguration directory). This can be edited within Cytoscape using the Preferences Editor (Edit-Preferences-Properties...) - look for taskStackSize. The value should be specified in bytes.