Ampullary Tool (test version)

This is a first version of my ampullary model tool for internal testing and discussion.
It is not packaged, but can be run locally using a Python virtual environment.

---

Requirements

• Python 3.10 (tested with 3.10.12)
• Git
• Terminal access

---

Getting the code

Clone or download the entire project folder from the internal GitHub repository.

The folder structure should look like this:

ampullary_ui/
├─ code/
├─ examples/
├─ source/
├─ stimuli/
├─ requirements.txt
└─ README.md

Setup instructions

1. Open a terminal and go to the project folder

cd ampullary_tool

2. Create a virtual environment

python3 -m venv venv

3. Activate the virtual environment

Linux / macOS:

source venv/bin/activate

Windows (PowerShell):

venv\Scripts\Activate.ps1

4. Install dependencies

python -m pip install -r requirements.txt

This installs all required packages inside the virtual environment.

Installation for usage

pip install .
# or
make install

Installation for development

pip install -e .
# or  
make install-dev

This should also build the qt resources file. If this needs to be done manually,

python build_resources.py --rcc
# or
make build-resources

We further need to compile the qt ui files that describe the user interface to respective UI classes.

python build_resources.py --ui
# or
make build-ui

Running the application

When installed, run the UI by calling from the command line

ampullary-gui

If everything works correctly, the application should open.