Installation & Setup

This page walks you through the one-time setup required to run RemoteRF on your personal computer: verifying your network connection, installing the Python client package, configuring your campus server address, and registering an account.

Network Connection

Anytime you use RemoteRF, your computer must be connected to the same network as the RemoteRF server:

• On Campus: For most universities, your standard campus Wi-Fi (such as eduroam) or a campus wired LAN connection will allow direct access to the server.
• Off Campus: When working from home, a dorm room outside the campus subnet, or while traveling, connect through your university’s Virtual Private Network (VPN) first. Once the VPN is connected, you can access the RemoteRF server from virtually anywhere.

Consult your instructor or laboratory administrator for deployment-specific network instructions and server addresses.

Python Environment

RemoteRF requires Python 3.10+.

We recommend using a dedicated virtual environment (such as conda or venv) to keep dependencies clean:

Option A: Using Conda (Recommended)

conda create -n remoterf python=3.11 matplotlib
conda activate remoterf

Remember: Anytime you open a new terminal to use RemoteRF, activate your environment first with conda activate remoterf.

Option B: Standard Python (venv / pip)

If you use standard Python without conda, simply ensure you have matplotlib installed for plotting received signals:

pip install matplotlib

Package Installation

Install the official remoterf client package from PyPI using pip:

pip install remoterf

Upgrading RemoteRF

Whenever updates or fixes are released, you can upgrade your installation with:

pip install remoterf -U

If you ever run into unexpected connection errors or driver issues, upgrading the client package should be your first troubleshooting step.

Package Configuration

After installing remoterf, you must configure it once to point to the IP address and port of your institution’s RemoteRF server:

remoterf -c -a <address:port>

For example, if your instructor provides the IP 123.45.123.456 and port 61005, run:

remoterf -c -a 123.45.123.456:61005

This command saves the server address to your local client configuration file. You only need to run this command once unless your server address changes.

Creating an Account

Before you can access SDR hardware, you need an account on your institution’s RemoteRF server.

Launch the interactive RemoteRF shell:

remoterf --login

When prompted, type r to register a new account:

During registration, you will need to provide:

1. Enrollment Code: A short code provided by your instructor or lab administrator that authorizes you to use the platform.
2. Username: At least three characters long.
3. Password: Choose a secure password.
4. Email Address: Your institutional email.

Important: Password recovery is not automated. If you lose your password, your administrator cannot retrieve it, and you will have to register a new account with a new enrollment code.

Next Steps

Now that your client environment is configured and your account is created, you are ready to log in, view online radios, and make your first reservation!