Neptune Downloads

Table of Contents



Neptune CLI works on Mac OS X, GNU/Linux and Windows. Additional software is required to be installed on the operating system:


Note: If you are using Python 2.7, use pip instead of pip3 in commands below.

Neptune can be installed with pip package manager:

sudo pip3 install

NOTE: If you are using virtual environment solution like virtualenv then you can run this command without a sudo.

pip3 install


Neptune CLI uses a configuration file or environment variables to establish a connection with Neptune Server.

Creating Configuration with a Configuration File

The configuration file should be located in ~/.neptune.yaml on Unix systems and in %USERPROFILE%\.neptune.yaml on Windows systems.

Create this file with the following content:

port: 443

HINT: You received YOUR_NEPTUNE_SERVER_HOST, YOUR_USERNAME and YOUR_PASSWORD during joining the Early Adopters Program.

Creating Configuration with Environment Variables

You can override the configuration specified in the .neptune.yaml file with environment variables. The variables should be exported in the terminal where Neptune CLI will be used.

export NEPTUNE_PORT=443

Creating Persistent Configuration with Environment Variables

You can set exported variables for every new session. The way of doing that is system-dependent.

Paste the snippet listed in the previous paragraph to ~/.bashrc or ~/.bash_profile.

Set NEPTUNE_HOST, NEPTUNE_PORT, NEPTUNE_USER and NEPTUNE_PASSWORD variables via System Settings in the Control Panel.

Post-Installation Verification Test

To check if you installed the correct version of Neptune CLI, run:

$ neptune -v

It should print:

1.5.1 (API: 1.5.1)

To check if you can establish connection with Neptune, run:

$ neptune ls

You should receive all jobs registered within your Neptune instance.


CLI + Python Client Library:

Client Libraries

Python Client Library


Python Client Library is bundled together with CLI. Please follow the instruction for CLI to install Python Client Library.

Post-Installation Verification Test

To check if you installed Python Client Library correctly, start a Python interpreter:

$ python
>>> from deepsense import neptune

This import should not cause any errors.

R Client Library


NOTE: You have to install the Java JDK version compatible with your R version (either 32- or 64-bit).


To install the required rJava package on Mac OS X or Linux, you need to have Java JDK 8 integrated with R.

To integrate the Java JDK with R, run the following commands:

$ export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:<path to your Java JDK installation>/jre/lib/amd64:<path to your Java JDK installation>/jre/lib/amd64/server"
$ sudo sh -c 'export JDK_HOME=<path to your Java JDK installation>; export JAVA_HOME=$JDK_HOME/jre; R CMD javareconf'

Then you can install rJava and Neptune R Client Library:

$ R
> install.packages("rJava", type = "source")
> install.packages("", repos = NULL, type = "source")

Install rJava and Neptune R Client library:

$ R
> install.packages("rJava")
> install.packages("", repos = NULL, type = "source")

If installation of rJava fails, you may need to unset the JAVA_HOME environment variable in the R console:

> if (Sys.getenv("JAVA_HOME") != "") Sys.setenv(JAVA_HOME="")

and repeat the installation procedure.

This is a known issue of the rJava library on 64-bit Windows.

Post-Installation Verification Test

To check if you installed the R Client Library correctly, start the R interpreter and load the library. You should see a message shown below.

$ R
> library(neptune)
Loading required package: rJava
Warning message:
In fun(libname, pkgname) :
  No arguments to initialize Neptune Context. This library should not be used outside Neptune jobs.
> packageVersion("neptune")
[1] ‘1.5.0’

The warning message was printed because you loaded the R Client Library outside a Neptune job. To use Neptune with your R code, you need to run the code as a Neptune job using CLI.


R Client Library:

Java Client Library



Java Client Library is available in Maven Central Repository:

Release Notes

  1. Added support for Python 3.5. Neptune is now compatible with both Python 3.5 and 2.7.
  2. Simplified Neptune CLI (read more). The most important changes:
    • new format of configuration files,
    • introduced hierarchy of configuration files,
    • all execution parameters can be specified in a configuration file,
    • changed parameters of neptune run and neptune enqueue:
      • --storage-url and --dump-dir-url parameters replaced with a single --storage parameter,
      • --paths-to-dump replaced with --paths-to-copy.
  3. Introduced OfflineContext in Neptune Client Libraries. Code integrated with Neptune can be run without Neptune CLI. In that case communication with Neptune server is turned off (read more).
  4. Introduced a compact view of the experiments table in Neptune Web UI. You can switch between compact and normal view in the “Table” menu.
  5. Merged “Charts” and “Dashboard” tabs in the experiment dashboard view in Neptune Web UI.
  6. Refactored API for channels and charts. Improved performance of loading channels and charts.
  7. Improved notifications about experiment status change. You can see only notifications about your experiments.
  8. Added persistence of charts created from Neptune Web UI.
  9. Improved experiments and jobs tables:
    • direct column removal,
    • unified scroll bars.
  10. Removed name property from metric.

Known Issues