The Analysis App#

The Analysis App is where you can work with Jupyter Notebooks. When you start the Analysis App you will see a Launcher tab. The tiles in the Launcher tab will create new tabs within the Analysis App environment that allow you to edit different file types, view documentation or manage your Python environment.

The Edge Analysis App with a Launcher tab

Note

If you have need to return to the Launcer tab, you can create one by clicking large blue "+" button at top left:

../_images/edge_analysis_launcher.png

Jupyter Notebooks#

Clicking on the Edge tile in the Launcher will create a Jupyter Notebook with the a predefined edge object. This built-in object give you access to a vast amount of data accessible via Edge's API. That includes uploaded files and other data, as well as remote data sources Edge has been connected to.

Edge Notebook

For example, you can use the following Python code in an Edge notebook cell:

edge.files.list()

Running the cell either with the Run button in the toolbar or pressing Ctrl-Enter on your keyboard will produce a list of your files on Edge. The result will look similar to this:

['Example Folder',
 'Experiments.txt',
 'Imported Data',
 'My Data',
 'Projects',
 'data.csv',
 'data_cleaned.csv',
 'image001.png',
 'image002.png',
 'image003.png']

Installing Python packages#

A large number of Python packages are pre-installed in your Python environment. Some users may wish to install additional packages. You can use a Terminal tab to install Python packages and manage your environment. From the Launcher tab, click on the Terminal option.

Starting a Terminal

You can also install packages using EDM, the Enthought Deployment Manager:

$ edm install somepackage

We recommend using edm to install packages. They have been extensively tested to make sure they work together. You can read more about EDM in the official EDM docs. If a package is not available in EDM, you may use pip to install it:

$ pip install somepackage

Cloning a Remote Repository#

If you have a repository hosted on a version control service such as GitHub or GitLab, you can clone it into your workspace by using the built-in git extension.

Clicking on "Git" in the top menu brings up the option to "Clone a Repository", which will then prompt you to enter the URI to your repository.

../_images/clonerepo.png

Note

If your repository is not publicly accessible, you will see a prompt asking for your credentials to the version control service. It is recommended that you use enter a "personal access token" instead of your password.

../_images/gitcredentials.png

Instructions on how to generate a personal token are available for GitHub. and GitLab.

If you are using a different service, check their documentation for more information.

Resetting Edge#

If you get into trouble, shut down any running notebooks and run the reset-edge command from the terminal. This will restore your package set to the "factory default" settings:

$ reset-edge

Resetting Edge will:

  * remove all custom Python packages and environments
  * restore your Python packages to factory default

You will NOT lose any files or notebooks.

Continue and reset Edge (y/n)?

Automatic Shutdown#

To preserve compute resources, any running kernel or terminal that is inactive for 30 minutes will be terminated. After that, if the Analysis App detects no activity for 4 hours, it will automatically shut down.