Service connectivity check

Standard startup flow:

1. Activate the vjem environment and start Python

2. Confirm that the required services are running

   • TEM3 packages: TEM3.connect()

   • Other packages: check_connection()

3. If not reachable: diagnose with get_config(), reconfigure with set_ip()

Prerequisites

• Miniconda is installed.

• A vjem environment is available (for example: vjem38, vjem310).

• PyJEM is already installed in the target vjem environment.

• For online operation, TEMCenter/TEMServer (or required services) are running.

Step 1: Activate vjem and Start Python

Open a command prompt and run:

conda activate vjem38
python

Replace vjem38 with the name of your environment (e.g., vjem310).

Step 2: Confirm that the required services are running

The method to use depends on the package:

Package type	Confirmation method
TEM3	TEM3.connect()
All other packages	package.check_connection()

Run the appropriate code cell below for your target package.

TEM3 package

# Step 2 (TEM3): Confirm TEM3 service is running
from PyJEM import TEM3

try:
    TEM3.connect()
    print("TEM3: Connected")
except Exception as e:
    print("TEM3: Connection failed ->", e)
    print("Verify that TEMCenter / TEMServer is running on the TEM PC.")

TEM3: Connected

others package

For packages other than TEM3, call check_connection() on each package.
True — the service is running.
False — the service is not reachable (check IP address and port).

# Step 2 (other packages): Check that each service is running
from PyJEM import detector, detectorext, eds, sightx, eels, eftem, stem4d

packages = {
    "detector":    detector,
    "detectorext": detectorext,
    "eds":         eds,
    "sightx":      sightx,
    "eels":        eels,
    "eftem":       eftem,
    "stem4d":      stem4d,
}

print(f"{'Package':<14} {'Connected':<12} ip        port")
print("-" * 55)
for pkg_name, pkg in packages.items():
    connected = pkg.check_connection()
    cfg = pkg.get_config()
    print(f"{pkg_name:<14} {str(connected):<12} {cfg.get('ip', '?')}    {cfg.get('port', '?')}")

Package        Connected    ip  port
-------------------------------------------------------
detector       True         127.0.0.1 49226
detectorext    True         127.0.0.1 49326
eds            True         127.0.0.1 49326
sightx         False        127.0.0.1 49260
eels           True         127.0.0.1 49326
eftem          True         127.0.0.1 49326
stem4d         True         127.0.0.1 49326

Appendix: If a service is not reachable

When check_connection() returns False:

1. Inspect current settings with get_config() — check the ip and port values.

2. Update the IP address with set_ip("x.x.x.x") to point to the correct host.

3. Retry check_connection() to confirm the service is now reachable.

# Appendix: Diagnose and reconfigure (example using detector)
from PyJEM import detector

if detector.check_connection():
    print("detector: Connected")
else:
    # 1. Inspect current settings
    config = detector.get_config()
    print("Not connected. Current config:", config)

    # 2. Update IP address to the correct host and retry
    new_ip = "127.0.0.1"  # Replace with the actual IP address of the service
    detector.set_ip(new_ip)
    print(f"IP updated to: {new_ip}")
    print(f"New config: {detector.get_config()}")
    print(f"Retry check_connection: {detector.check_connection()}")

detector: Connected