Repository navigation
Getting Started
This page helps you get familiar with actinia, explore its API and choose a suitable deployment option.
The following resources provide an introduction to actinia and its main concepts:
- actinia documentation, tutorials and examples
- A gentle introduction to actinia — present a detailed chapter about the actinia command execution(ace)
- A gentle introduction to actinia — an introduction to the HTTP API with extended exercises
- Jupyter Notebook examples — basic API calls in Jupyter Notebooks
For an overview of the main concepts and components, see Components of actinia.
actinia is documented using the OpenAPI standard, also known as swagger. The API documentation describes the available endpoints, request parameters and response models.
- API documentation
- OpenAPI definition
- Interactive Redoc documentation
- Petstore swagger UI — can be used to show all available REST API calls and all response models in a convenient way.
The latest releases and changelog are available in the actinia-core releases.
actinia provides access to GRASS GIS modules and addons through its REST API. The available modules depend on the actinia installation and the permissions assigned to the user.
A selection of modules available on the demo instance can be explored here:
-
Available modules on the demo instance (user:
demouser, password:gu3st!pa55w0rd)
Some modules provide dedicated functionality for actinia process chains:
- actinia importer — import data within a process chain
- actinia exporter — export data from a process chain
For more information about process-chain templating, see the actinia-module-plugin documentation. For plugin-specific examples and process chain resources, see Plugin examples and resources.
actinia can be deployed in different ways depending on your environment and requirements:
- Docker — recommended for a quick local or server-based setup
- Helm — suitable for Kubernetes or OpenShift deployments
- pip and PyPI — suitable for custom Python-based installations
For configuration details after deployment, see: