Automancer docs

Getting started with Automancer

Install Python

Automancer requires Python 3.11 or later to function.

  • On Windows, install Python using the official installer.
  • On macOS, the recommended way is using Homebrew. First install Homebrew and the run brew install python in the Terminal application. It is also possible to use the official installer.

Install Automancer

If you haven't already, download the application from the homepage for your platform.

Then, depending on your operating system:

  • On Windows, open the installer and wait for it to finish. The application should open at the end of the installation, which may be very quick depending on your computer.
  • On macOS, unarchive the .zip file and drag the application to the Applications folder. Then open the application from there. It is likely that an error message will appear, saying that the application is from an unidentified developer. In that case, open the System Preferences/System Settings, go to Security & Privacy, and click on Open Anyway.

Create a setup

Now that you have installed Automancer, you will need to create a first setup to experiment.

  1. Press New setup in the launch window to begin.
  2. Select Advanced configuration and continue. The "Simple configuration" is not implemented yet.
  3. Enter a setup name and make sure the Create a virtual environment option is checked. Select a Python installation with a version of 11.0.0 or later. Press continue.
  4. This latest core packages required for Automancer to function are now being installed in a Python virtual environment. Note that an Internet connection is required during this step. After a few seconds or up to a few minutes, the setup should be ready. Press Launch to continue.

Explore the application

There are four main views in the application, which can be accessed using the icons in the sidebar, on the left:

  1. The first view, which opens when launching the app, is the Experiment List. This view displays all current and past experiments. By clicking on an experiment, you can see its progress (if is is currently running) or its results (if it is finished).
  2. The second view is the Protocol Editor. This view displays all files that have registered as protocols. By clicking on a protocol, the editor will open and you will be able to edit, preview and eventually execute the protocol.
  3. The third view is the Settings. This view allows you to configure the application, the setup and its plugins.
  4. The fourth view is the Device Control Panel. This view provides easy access to all connected devices. By clicking on a device, you can see whether it is connected and what its current status is. You will also be able to manually control any device.
  5. More views can be added by installing plugins. In fact, the Device Control Panel is generated from a plugin itself.

Next steps

You can now start using Automancer! To add plugins to the setup, see Managing setups. To start writing protocols, see Getting started writing protocols.