Quick Start

This section covers running AugeLab Studio without the desktop UI via the public API class studio.StudioScenario.

Whatever your platform is, AugeLab runtime is guaranteed to work the same way. { % endhint %}

Quick Start

Now, we'll walk you through a quick example of running a headless scenario using Python code.

We are going to create a simple calculus scenario, and manage it via Python code.

Open AugeLab Studio desktop application, and create a new scenario with the following blocks:

Headless Calculus Example

Save the scenario as calculus_example.pmod.

Create a new Python script with the following code:

headless_calculus.py

from studio import StudioScenario
scenario = StudioScenario(verification_code="YOUR_CODE_HERE")
scenario.load_scenario("calculus_example.pmod")
for i in range(5):
    result = scenario.run((i,))
    print(f"Input: {i}, Output: {result[0]}")
scenario.cleanup()

Replace YOUR_CODE_HERE with your actual verification code.

We need to use the python executable that has AugeLab Studio installed. If you are using virtual environments, make sure to activate the correct environment first. { % endhint %}

Run the script, and you should see the following output:

python headless_calculus.py

Running this should give you an output similar to:

... # studio initialization logs
1
2
3
4
5

Transferring .pmod files

Transferring .pmod files are pretty straightforward. You can simply copy the .pmod files created in the desktop application to your headless environment.

If your .pmod file uses any external resources (e.g., images, models), before copying, make sure you have the following folder structure:

\project
    scenario.pmod
    \resources
        template.jpg
        model.weights
        model.names
        model.cfg
        ...

And saving the scenario before transferring the files. You can easily test this by moving your project folder to another location and running the scenario there again.

Some custom blocks may require additional resources or dependencies to be transferred or installed in the headless environment. Make sure to check the documentation for any custom blocks you are using. { % endhint % }

Wrapping Up

You are now ready to run your own headless scenarios using AugeLab Studio! Explore the various blocks and functionalities available in the desktop application, and leverage them in your headless Python applications.

For further details on advanced features, please continue to read.