Get started with VIKTOR

New to VIKTOR? Then you're in the right place. This is your go-to place for all the important info you need to start using VIKTOR. Here, you’ll find links to everything from the basics of VIKTOR, how it works and is organized, to creating apps and understanding the VIKTOR interface. Happy exploring!

Using VIKTOR

What is VIKTOR?

• Why use VIKTOR?
• How VIKTOR works
• What can you do with VIKTOR?

How is VIKTOR organized?

• Build apps
• Connect apps
• Share & use apps

Creating apps

Want to start creating your own app? We recommend you start with the App Builder. It’s the easiest and quickest way to create an app. Prefer your own IDE. It's also possible to install and develop VIKTOR apps locally.

See Two ways to build a VIKTOR app for more information about the differences in build methods.

Getting started with the App builder

You can create a new app using the App Builder directly from the Home page in the VIKTOR environment.

1. Under Start building you will find the button Create new app.
2. If you click on this button you land in the App Builder.

You can also try out one of the example prompts on the right.

Go to App Builder for more detailed information on how to use the App builder, its features and limitations.

Getting started with Local development

To start developing apps locally you need to install Python and VIKTOR on your own computer. That is assuming you already have an IDE installed.

1. Go to your personal settings > local development.
2. Here you click on Install VIKTOR.
3. The pop-up will guide you through the installation process.

After you complete the installation, you can continue to the next step, the starter guide.

• Starter guide

  Learn the basics of developing an app in VIKTOR

  Learn more

Go to local development to learn all about the different tools you will be working with.

Fundamentals

Whether you start with the App Builder or develop your app locally. It’s good to know some basics.

Basic app structure

• App file structure
• Inputs (parametrization)
• Results & visualizations

App types

• Editor type
• Simple type
• Tree type

VIKTOR components

Learn about the different types of fields and visualizations VIKTOR has to offer.

Inputs

Add fields, sliders, uploads, etc so users can give your app the information it needs.

Results

Show plots, charts, 3D models, tables and maps to visualize the results.

Layouts

Arrange how inputs, results, and other elements appear to make your app easy and intuitive to use.

Integrations

Eliminate manual data transfers between different software packages and disciplines.

• Integrations

  Learn more about the integration options VIKTOR offers.

  Learn more

Collaboration

Share your apps and collaborate with your team.

• Sharing your app

  Learn how to collaborate with other users on your app.

  Learn more