Installation

Prerequisites

Installation Methods

Option 1: Install from PyPI (Recommended)

The easiest way to install the converter is directly from PyPI:

pip install PyDMConverter

Option 2: Install from Source

If you need the latest development version or want to contribute:

Clone the Repository

git clone https://github.com/slaclab/pydm-converter-tool.git
cd pydm-converter-tool

Set up Environment

Using conda:

conda env create -f environment.yml
conda activate pydm

Or using pip:

pip install -e .

How to Run the Converter

The converter can be run in two ways: via the command line interface (CLI) or through the graphical user interface (GUI).

Launch the GUI

To launch the graphical interface:

pydmconverter

This will open the PyDM Converter GUI where you can: - Select files or folders to convert

Command Line Interface

The CLI provides two main ways to run the converter: on individual files and entire folders. Users can include additional arguments described on the Arguments page.

For individual files

When using the converter on a single file, the command line is:

pydmconverter '/path/old_file.edl' 'new_file_name.ui' `

For an entire folder

When converting an entire folder, the command line is:

pydmconverter '/path_to_old_directory' '/new_file_location' 'old_file_type'

Examples

To convert EDM file called "file.edl" to PYDM file called "file.ui" :

pydmconverter /afs/slac/g/lcls/edm/file.edl file.ui`

To convert EDM files in a folder called "edm" to PYDM file in the current folder :

pydmconverter /afs/slac/g/lcls/edm . .edl`