Skip to content

Latest commit

 

History

History
216 lines (145 loc) · 9.9 KB

README.md

File metadata and controls

216 lines (145 loc) · 9.9 KB
Raw

Radboud FUS driving system software

ru_logo fus_logo igt_logo

📗 Table of Contents

📖 Radboud FUS driving system software

(Project id: 0003496 )

The Radboud FUS driving system software is designed to streamline the integration of new focused ultrasound equipment into your workflow. It enables control of the equipment while limiting the need for users to familiarize themselves with new software interfaces.

Features

  • Seamless Integration: The current version offers essential functionality that can be easily integrated into your experimental code to control the system during your experiments.
  • Compatibility: This package is also a prerequisite for the latest version of the SonoRover One software, which utilizes it to communicate with your focused ultrasound equipment. By adhering to a standardized communication structure, the characterization software does not need to directly handle communication protocols. Instead, it uses the same codebase for both standalone and experimental settings, ensuring consistent and centralized updates to equipment communication.

This project is facilitated by the Radboud Focused Ultrasound Initiative. For more information, please visit the website.

Important Note

This package is developed specifically for Windows operating systems. While it might work in other environments with some modifications, full support is provided only for Windows.

👥 Authors

👤 Margely Cornelissen, FUS Initiative, Radboud University

👤 Erik Dumont, Image Guided Therapy (IGT)

👤 Stein Fekkes, FUS Initiative, Radboud University

(back to top)

✒️ How to cite

If you use this package in your research or project, please cite it as follows:

Margely Cornelissen, Stein Fekkes (Radboud University, Nijmegen, The Netherlands) & Erik Dumont (Image Guided Therapy, Pessac, France) (2024), Radboud FUS driving system software (version 0.9)

💻 Getting Started

To get a local copy up and running, follow these steps.

Installation

Step 1: Clone this repository to your desired folder

Step 2: Download Python 3.10
Ensure you have Python 3.10 installed and accessible from your command line. If Python is not installed, download it from the official Python website. It is not necessary to add Python to your system's PATH during installation, as virtual environments allow you to manage and switch between Python versions without affecting other projects or code outside the environment.

python_path

Note: The script assumes that Python 3.10 is installed. If you have a different version, make sure to adjust the script accordingly or install Python 3.10.

Step 3: Create and setup a virtual environment
Open your command prompt and run the following batch file to set up the virtual environment and install the necessary dependencies. You can use input parameters to customize the environment name or directory, or Python interpreter location. You must either rely on all default or provide all input parameters.

cd your_directory_with_cloned_repository
create_venv.bat "[PYTHON_INTERPRETER_PATH]" [VENV_NAME] "[VENV_DIR]"
  • PYTHON_INTERPRETER_PATH: Specify the path to the Python 3.10 interpreter if it’s not in the default location. For example, C:\Path\To\Python310\python.exe.
  • VENV_NAME: Specify the name for the virtual environment (e.g., MyEnv). If not provided, it defaults to FUS_DS_PACKAGE.
  • VENV_DIR: Specify the directory for the virtual environment (e.g., C:/Users/Me/Envs). If not provided, it defaults to C:/Users/{USERPROFILE}/Envs.

Example:

create_venv.bat "C:\Path\To\Python310\python.exe" FUS_DS_PACKAGE "C:/Users/Me/Envs"

The batch file will create a virtual environment and install the required Python packages.

Step 4: Verify the successful setup of the virtual environment
After running the batch file, ensure that the virtual environment and dependencies are installed. You can verify this by:

  • Checking for the virtual environment folder in your VENV_DIR directory.

    verify_venv

  • Confirming that the fus_driving_systems package is installed in the virtual environment site-packages folder: VENV_DIR/VENV_NAME/Lib/site-packages/.

    verify_fus_package

Troubleshooting

If you encounter issues with the batch file not being recognized or errors occur during execution, ensure that:

  • The batch file has the correct permissions to be executed.
  • The repository has been cloned correctly and contains the necessary files.

Usage

Step 1: Activate your environment
With the fus_driving_systems package installed, activate your environment in your command prompt to create and execute sequences.

call [VENV_PATH]\Scripts\activate

Step 2: Install an IDE
While the virtual environment is activated, you can install Spyder or any other IDE of your choice. To install Spyder, run:

pip install spyder

Step 3: Launch the IDE
After installing Spyder, you can launch it directly from the command line within the activated virtual environment by running:

spyder

Step 4: Open the main script
Open one of the Python scripts provided in the 'standalone_driving_system_software' directory in the cloned repository, which serve as examples of how to create and execute a sequence with a driving system from a specific manufacturer.

Follow the instructions within the code to understand how to integrate it into your own codebase. Additionally, these scripts can be utilized to explore the functionality of the package before integrating it into your project.

Activate your virtual environment and launch the IDE at once

To simplify the process of activating the virtual environment and launching your IDE, you can use the provided batch script.

How to use the script:

  1. Ensure that start_env_and_ide.bat is located in a convenient location, such as the root directory of your project or your desktop.
  2. Run the script in one of the following ways:
    • Open start_venv_and_ide.bat in a text editor and modify the VENV_PATH and IDE variables directly if you prefer not to use command-line arguments. To run the .bat file, just double-click it.
    • Using the command prompt: 
       start_venv_and_ide.bat [VENV_PATH] [IDE]
      • VENV_PATH: Specify the path to the virtual environment (e.g., C:/Users/Me/Envs/MyEnv). If not provided, it defaults to C:/Users/{USERPROFILE}/Envs/FUS_DS_PACKAGE.
      • IDE: Specify the python interpreter. IF not provided, it defaults to spyder.

(back to top)

🔭 Future Features

  • A GUI to display, plan and execute an US sequence
  • Compatibility check of chosen equipment
  • Control a driving system with two transducers plugged-in

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

If you have any questions, please feel free to reach out to us via email at [email protected]. We'd love to hear from you.

(back to top)

📝 License

This project is MIT licensed.

(back to top)