Skip to main content

Introduction to projects

A project is the central organizational unit in Hex. It includes the Logic View, App Builder, and Environment views.

Projects home

Your default landing page in Hex is the Projects page. You can quickly find projects you created, as well as those shared with you and your workspace.

Each section of the Projects page can be filtered by the category and status of projects, which are defined by workspace Admins.

You can also see a variety of metadata about each project, including your level of access, the project creator, the time of last edit, and publication status.

Creating a new project

There are two options for creating new projects.

Create a project from scratch

Select the New project button on the Projects page to generate an empty project.

You'll be prompted to name the project, select your desired project languages, and optionally add a description, status, and any categories. By default, projects will be created using a Medium compute profile, which offers 8 GB of memory and 2 CPUs. The compute profile can be changed from the project creation modal or via the Compute profile section of the Environment side panel.

Upload existing Jupyter Notebooks

You can upload any existing .ipynb (Jupyter Notebook) file into Hex. Because this file format typically stores the outputs from the last time it was executed, the outputs will often appear instantly in the project without needing to be re-run.

caution

While we support upload of any .ipynb file, you may run into package-related issues while migrating your work from environment to environment. See the Package Management section for more details on configuring your environment in Hex.

Project options

Once you are inside the project, the project name dropdown offers several options for a project:

Rename the project

Project Owners can rename the project.

Duplicate the project

Users with Author or Admin roles that have Viewer or higher project access can duplicate the project. The new, duplicated project does not inherit any project sharing permissions from the original.

Export as .yaml or .ipynb

There are two options for file export: .yaml or .ipynb. Projects can be exported by users with Viewer permissions or higher. Learn more on how to use the file format options here.

Delete the project

To delete a project, select Move to trash from either the project dropdown menu or the homepage project listing. Projects will remain in the trash for 7 days, at which point they will be permanently deleted. Any permanently deleted projects will be fully removed, along with all historical versions and published apps. Deletion is only executable by project Owners.

Clear outputs

This option is only available from the projects page. Clicking "Clear outputs" will clear the outputs from all cells in your project. This option is intended to be used in situations where a cell generates a very large output that crashes or overwhelms your browser. After clearing the project's outputs, it's recommended to avoid rerun the project in order to avoid regenerating the large output. Instead, identify the cell that generated the large output, and either delete or modify it before rerunning the project.

Project metadata

At the top of the Logic View, you'll find the project metadata section. Here you can:

Title & Description

The title and description of a project are visible in several places:

The title and description are also search indexed, so make sure to include any relevant keywords that you would expect people to use when searching for a project.

Status & Category

Projects can be tagged with one status and multiple categories. You can use these project labels to filter the main Projects home to organize large numbers of projects. Status and Category can be optionally displayed in a published app via the App metadata configuration.

Workspace administrators can edit and add new statuses and categories from the Settings & administration Panel.