Skip to content

System Projects

Organization administrators can use the Projects page in the System section of Cirro to create new projects or edit existing ones.

Finding a Project

Projects are organized in a table and by default are sorted by their name. You can change the sorting and add/remove columns using the three dots in the table header table icon, and also filter the projects using the sidebar on the right side of the page.

When filtering the data, you can search the text of a projects's name, description, and any tags, or select from any of the available filtering options.

Project Status

Each project has a status that can be viewed in the table on the System's Project page. In the table view, the status will be represented by an icon. There are four options for the status of a project:

  • pending icon Status: Pending: When the creation or updating of a project has been triggered, but has not started running yet.
  • running icon Status: Running: When a project is actively being created or updating.
  • completed icon Status: Completed: When a project is online and working as expected.
  • error icon Status: Error: When there is a problem in the project. This status means the project is not available for use.

Creating a Project

Organizational admins can create new projects from the System's Projects page using the "Create Project" button at the top of the page. This opens a pop up where you can fill out the following information.

  • Project Name: A unique name for your project.
  • Project Description: (Optional) A 1-2 sentence description of your project.
  • Contact Name: The name of the person that will be contacted with any issues about that project.
  • Contact Email: The email of your contact person.
  • Contact Organization: The name of the organization associated with your contact person.
  • Contact Phone: (Optional) The phone number of your contact person.
  • Billing Account: Select the billing account you want to charge for costs incurred in the project (e.g. data storage and running pipelines).
  • Budget Amount: When the project's total cost for the selected billing period (e.g. per month, per quarter, per year) approaches this amount, the project's contact person will receive emails. When this amount is reached, any pipelines and notebooks will be cut off and the data files will be saved.
  • Budget Period: The time period you want associated with your budget amount. This can be monthly, quarterly, or annually.
  • Allow SFTP Access: Check to allow users to access the project using SFTP.
  • Allow users in your Cirro organization to search for your project: Check to allow users who are part of your greater Cirro organization, but not part of your project, to view your project name in order to send an access request or send a dataset share.
  • Allow datasets in this project to be shared: Check to allow project admins to share datasets in your project with other projects. All projects can accept shares from other projects regardless of this setting.
  • Service Connections: Which of your organization's shared services are connected to this project.
  • Deleted Dataset Retention: The number of days to keep deleted datasets before being permanently erased.
  • Temporary Storage Lifetime (days): The number of days to keep temporary storage space (e.g. workflow executor cache) before being erased. The default for new projects is 14 days.
  • Maximum number of vCPUs for Spot Instances: The maximum number of compute cores you can launch at once for pipelines when you're doing batch processing. The nodes with these compute cores will not have GPUs available. 300 is a reasonable value for most projects, but if you want to run highly parallelized work you may want to add more. Feel free to contact the Cirro team with questions.
  • Maximum number of vCPUs for GPU-enabled Instances: The maximum number of compute cores you can launch at once using nodes which also have GPUs available. The default for new projects is set to 0. Note that increasing this value for the first time in a project may take 1-2 business days as AWS reviews the required quota increase request.
  • Maximum number of vCPUs for FPGA-enabled Instances: The maximum number of compute cores you can launch at once for Field-Programmable Gate Array (FPGA) enabled instances. The default value for new projects is 0.
  • Account Type: Whether the AWS account connected to this project is created and hosted by Cirro or if Cirro uses a separate, pre-existing AWS account. This decision cannot be changed once the project is created. View our installation guide if you decide to use your own AWS account.
  • Data Classification: Select any pre-defined data classifications that apply to the project's data, which can then be used to set governance requirements. Only organization admins are able to edit these classifications.

Editing a Project

To edit an existing project, click the row in the table. You will see a pop up that contains the same options as above, and a list of action buttons with more options:

  • View Project: Navigate to the project's Overview page.
  • AWS Jobs Info: View information on the project's job queues in AWS.
  • Compute Environments: View compute environments that the project can use when running pipelines. Organization-level administrators, can add or edit environments by choosing the agent, a name for the environment, and any environment variables that will be provided to the job at runtime.
  • Governance Summary: View any files uploaded by the project in order to configure requirements that are defined by organization administrators and currently enacted.
  • Redeploy Project: Re-deploy the project's AWS resources.