Installing Python
Non-venomous.
Using Python and Astra Image together can produce some powerful image processing solutions. Before using Python in Astra Image, please make sure to set up Python correctly.
Download and Install Python If you have Python installed on your system already, you can skip this step.
Go to python.org and download one of the 'Windows installer (64-bit)' files. Follow the prompts to install Python on your system.
Start a Command Prompt Hold down the Windows key and press R (Win+R). Then type cmd in the Run box. Another way to do this is to click on the Start menu, type cmd, and then click on 'Command Prompt'.
To test your Python installation, type:
py
and press Enter. You should see something like this:
Python 3.12.4 (tags/v3.12.4:8e8a4ba, Jun 6 2024, 19:30:16) [MSC v.1940 64 bit (AMD64)] on win32 Type "help", "copyright", "credits" or "license" for more information.
You can type:
quit()
end press Enter to get back to the command prompt.
Setup a Virtual Python Environment Virtual environments are a very useful feature of Python. They allow us to setup an instance of Python that is isolated from system Python. If you make a mistake or something gets broken, you can delete the virtual environment folder and start again (but always be careful when deleting files. Make a backup if you are not sure). Now, let's set up a virtual Python environment for Astra Image.
At the command prompt, type:
py -m venv C:\Users\UserName\PythonAstraImage
(if you already have Python installed, you might be able to use: python -m venv C:\Users\UserName\PythonAstraImage)
and press Enter.
You can change the path ('C:\Users\UserName\PythonAstraImage') to another location. But please remember the path you selected for the virtual environment.
After that, go to the the 'Scripts' folder where the virtual environment is installed:
cd C:\Users\UserName\PythonAstraImage\Scripts
and type:
activate
then press Enter.
Your command prompt should look like:
(PythonAstraImage) C:\Users\UserName\PythonAstraImage\Scripts>
Install Packages You are now ready to install Python packages. Two common packages that you will most likely need are numpy and OpenCV. To install them, run these four commands:
cd C:\Users\UserName\PythonAstraImage pip install numpy pip install opencv-python pip install opencv-contrib-python
You might also want to install other packages, like PyTorch or SciKit.
Python in Astra Image Start Astra Image and click on 'Python Script Editor...' in the Script menu. You will see an error message that says Python cannot be found. Click OK, then you will see the script window:
Click the Settings button on the toolbar (the right-most icon). You will then be able to select the location of your Python virtual environment:
You can use the '...' button to open the Select Folder dialog. Select the folder where you created the Python virtual environment (in this example, the path is 'C:\Users\UserName\PythonAstraImage') . Then click 'OK'.
You are now ready to write Python scripts.
Verification To test your installation, you can run a small script. In the script editor, type:
import AstraImage as ai import sys print('Python version: ', sys.version)
Then press the Run button. In the output section of the editor screen, you should see the Python version information:
Python version: 3.12.4 (tags/v3.12.4:8e8a4ba, Jun 6 2024, 19:30:16) [MSC v.1940 64 bit (AMD64)]
Next Steps Congratulations! You can now integrate Python scripts into Astra Image. For more information, please see the next topic, 'Writing Scripts'.
Last updated
