Get started
Getting started with Upfreq Studio
From a fresh install to your first session and your first saved work.
This guide takes you from a fresh install to your first saved work. It takes about half an hour, most of it waiting for the first download. Haven't installed Studio yet? Start with Install.
First run
- Open Upfreq Studio from your applications.
- Set up this machine. Studio checks Docker, the GPU, disk and memory. If a line fails, it tells you how to fix it; then press Check again. Press Download to fetch what Studio runs: about 10 GB, once per version.
- Sign in with Google or GitHub. Your browser opens; sign in, then come back to Studio.
- Connect GitHub on the Assets page. It opens the Upfreq GitHub App on GitHub, where you choose the repositories Upfreq may use. Create an empty repository for your twins and worlds first (for example
upfreq-assets), give the app access to it, then choose it in Studio as your assets repository. See GitHub connection. - The first time the AI agent starts, it asks you to sign in to your account with it. Later sessions remember it.
Your first session
Click New session. It opens straight away and the agent asks what you are making. Answer in your own words; the session appears in the sidebar under In progress.
On the left are the live sim view and the Data view; on the right, the AI agent with terminals under it. You can drive and test in the sim yourself, and the agent can see and steer it too. More in The session.
A good order for a first day:
- A digital twin of your robot, from its URDF or xacro, or from photos or a video.
- A sim world for it to work in.
- Robot software: pick the twin, the world and a repository, and ask for a behaviour.
"Here's our mobile manipulator's description repo. Import the mir_ur xacro and check it can drive and hold the arm."
Save often
In a twin or world session, Save commits and pushes it to your assets repository, with a picture. Saved twins and worlds appear on Assets. Robot software is saved as commits and a pull request in its own repository.
Tips
- One session at a time. Opening another one asks you to stop the running one first.
- Ask the agent. It follows Upfreq's workflow for each kind of session and knows the common fixes, so "why does it fall over?" or "what's next?" are good questions.
- Closing Studio closes the session: its sim, the agent and the terminals. Open the session again later and the agent carries on the conversation.
- Studio's shortcuts use Ctrl+Shift, so the plain Ctrl keys stay with the agent.
Feedback
Your feedback shapes what we build next. We especially want to hear:
- where you got stuck, and what you expected to happen instead;
- what the agent got wrong, or needed you to explain twice;
- twins or worlds that wouldn't import or didn't behave like the real thing;
- what you would need to use Studio for your real work.
Write to connect@upfreqrobotics.com. Screenshots, the session's name and the time help a lot.