Start a Project
These instructions assume you already have a Saturn Cloud account. If you do not yet have an account, it’s fast and easy to create one.
Navigate to Saturn Cloud Hosted, and log in.
From here, you can choose to start a pre-built project, or create your own from scratch.
Use a Quick-Start Project
Getting a quick-start project is as easy as clicking a card! As you see here, we have a number of project templates ready for you to try, and you don’t need to set any of the custom parameters to begin.
When you click one of these cards, you’ll be asked to confirm that you want to create it, as shown.
Then, you’ll be taken to your fully set up project!
To start your resources and begin working, click the green arrows as shown, on the Jupyter instance and the Dask cluster.
Your machines will start up, and when ready the “Jupyter Lab” button will turn bright blue, letting you know you can select it. Click that button, and you’ll find yourself in a full featured Jupyter Lab workspace, and you’re ready to run code!
Create a Custom Project
If you want to set up your own project, and use your preferred specifications, that’s also easy to do. Click the “Create Project” button in the left menu, or from the Project page, click “Create Project” in the top right corner.
From here, you’ll see a form with the Create Project options.
Set Custom Options
Identify the project with a name of your choosing, and if you like, provide a description. If you will want to use SSH to access this project later, click the appropriate button. (If you need more information, visit our page about SSH connection. )
This will choose how much memory your machine will have. If you plan to store very big data files, you may want to increase from the default, but otherwise the default of 10GB is a good place to start.
Choose what sort of hardware you will want for your Jupyter instance. Unless you plan to use GPU computing, CPU is probably a good choice. A T4 GPU will be less powerful but also less expensive than a V100 GPU. Choose the size of machine that will suit your needs - don’t worry about choosing wrong, you can always edit this later. If you want more info, we have an article about how to think about the machine you need.
An image will describe the libraries and packages you need to run your code. Make sure that if you choose a GPU based machine, you also choose a GPU image. You can choose from the Saturn Cloud default image selection when you create a project. This is the same way you will select a custom image, if you choose to create one.
However, if you don’t know what sort of image you want, or need to set up a custom image, you can visit our Images documentation to learn more.
Choose an auto-shutoff time interval that works for you. This will help you avoid any unwanted expenses.
If you know the Git repositories you want to use, you can select them now - but if you don’t know yet, or haven’t added them, don’t worry - you can edit all of this later. We have a set of instructions for how to connect to your Git repos that might be helpful!
Click “Create” to have your new project built. After this, you’ll be taken to the project page that shows the parameters you’ve requested.
Advanced Settings (optional)
There are some additional customization options you might want to apply, mainly the Start Script and Environment Variables. When you create the project, if you scroll down to “Advanced Settings (optional)” and open the section, you can customize the Start Script and/or Environment Variables for the client and the workers your project might contain. These settings are applied every time the Jupyter server (and cluster) spin up.
To start your Jupyter instance and begin working, click the green arrow as shown.
Your instance will start up, and when ready the “Jupyter Lab” button will turn bright blue, letting you know you can select it. Click that button, and you’ll find yourself in a full featured Jupyter Lab workspace, and you’re ready to run code!
Need help, or have more questions? Contact us at:
- On Intercom, using the icon at the bottom right corner of the screen