User Guide

Prerequisites

Before you begin, ensure you have the following:

Installation

The recommended path is installing ndp_ep with the rexec extra, which pulls in both the NDP Endpoint client and the SciDx-rexec library as a dependency.

pip install ndp_ep[rexec]

pip install "ndp_ep[rexec]"

# Create and activate a fresh environment first
conda create -n rexec-env python=3.11 -y
conda activate rexec-env
pip install "ndp_ep[rexec]"

Verify installation

python -c "import ndp_ep; print('ndp_ep OK'); import rexec; print('rexec OK')"

What You Need From Your Sysadmin

Using Rexec via NDP Endpoint

The primary way to use Rexec is through the ndp_ep library, which orchestrates authentication, server provisioning, and job dispatch in one place.

Connect to an Endpoint

from ndp_ep import APIClient, remote_func

ndp_ep_client = APIClient(
    base_url="https://ndp-endpoint.example.org/api",
    token="<your-bearer-token>"
)

Provision the Remote Environment(rexec server)

ndp_ep_client.setup_rexec_environment( requirements="input_requirements.txt" )

Define and Send a Remote Function

@remote_func
def compute_pi(n: int) -> float:
    """Estimate pi using Leibniz series."""
    pi = 0.0
    for i in range(n):
        pi += (-1)**i / (2*i + 1)
    return 4 * pi

# Simply invoke the function, it serialized the wrapped func and send it to remote Rexec server
result = compute_pi(n=10000000)
print(f"π ≈ {result}")

Example Notebooks

Two example notebooks are included in the repository to help you get started:

Authentication

All requests are authenticated via Bearer tokens. The NDP identity provider issues these tokens. The token is validated by the broker, deploy API, and NDP Endpoint API, all using the same AUTH_API_URL.

Troubleshooting

Connection timeout

If remote func invocation hangs or times out, check that:

• The Rexec broker NodePort (30001) is reachable from your network
• Your token is valid and not expired
• The NDP Endpoint has REXEC_CONNECTION=True in its configuration

ModuleNotFoundError: scidx_rexec

pip install "ndp_ep[rexec]"  # re-install with the rexec extra

zsh: no matches found: ndp_ep[rexec]

Wrap the package name in double quotes so zsh doesn't interpret the brackets as globs:

pip install "ndp_ep[rexec]"

Authentication error (401 / 403)

• Ensure your token hasn't expired — obtain a fresh token from your identity provider
• If using group-based access: confirm your account belongs to the configured group

FAQ