QMCUHK Website Updater - Installation Guide
Installation & Usage Guide
⚠️ Before You Start - Important!
  1. Get GitHub Access: Contact the current website maintainer to get an invitation to the qmcuhk GitHub organization.
  2. Accept the Invitation: Check your email and accept the collaboration invitation for the qmcuhk.github.io repository.
  3. Clone the Repository: Clone the website repo to your local computer: 
    git clone https://github.com/qmcuhk/qmcuhk.github.io.git
    Remember the folder path - you'll need it when registering in the app!

Download

Download QMCUHK Updater v1.0.0
qmcuhk_updater-1.0.0-py3-none-any.whl (~5 KB)
Requires Python 3.8 or higher

Installation

1
Install Python

Make sure you have Python 3.8 or higher installed. Download from python.org if needed.

Verify installation:

python3 --version
2
Install the App

Open Terminal, navigate to where you downloaded the .whl file, then run:

pip3 install qmcuhk_updater-1.0.0-py3-none-any.whl

This will automatically install all dependencies (PyQt5, requests, PyYAML).

Alternatively, you can use a virtual environment if you prefer to keep packages isolated.

3
Run the App
qmcuhk

The GUI will launch! You can run this command anytime from any folder.

First Time Setup

  1. When the app launches, click "Register" to create your user profile.
  2. Enter your username (your name).
  3. Optionally enter your GitHub username.
  4. Click "Browse" and select the folder where you cloned qmcuhk.github.io.
  5. Click OK to register and login.

Next time you open the app, just select your name and click Login.

What Can You Do?

Watch the video tutorial on YouTube for step-by-step instructions.

👥
Manage Members
📄
Add Publications
📰
Post News
📋
Edit Openings
📚
Update Teaching

Usage Tips

Adding Publications

You can import paper info automatically! Just paste a DOI or arXiv ID (e.g., 2303.02865) and click "Fetch".

After Making Changes

The app modifies files in your local repo. To publish changes to the website:

cd /path/to/qmcuhk.github.io
git add .
git commit -m "Update website"
git push

Changes will appear on qmcuhk.github.io within a few minutes.

Running the App Later

Just open Terminal and type:

qmcuhk

That's it! The command works from anywhere.

Troubleshooting

Command not found: qmcuhk

Make sure the installation completed successfully. Try running pip3 install qmcuhk_updater-1.0.0-py3-none-any.whl again. You may need to restart your terminal.

Invalid Folder Error

The app expects the website folder to contain: _members, _data, _pages, _notes, assets. Make sure you selected the correct folder.

Need Help?

Contact the previous maintainer or check the repository documentation.