# workshop_for_rest

**Repository Path**: restgroup/workshop_for_rest

## Basic Information

- **Project Name**: workshop_for_rest
- **Description**: REST 研讨会系列：从基础到进阶应用；历届研讨会记录
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2025-09-04
- **Last Updated**: 2025-12-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Prepare for REST Workshop

## Install Docker via Docker Desktop
Installing Windows Subsystem of Linux (WSL) is recommanded. See [here](https://learn.microsoft.com/zh-cn/windows/wsl/install).

Install the Docker Desktop by Docker Desktop Installer (for Users on Windows), which is included as materials of the workshop. One can also download manually at [Docker Homepage](https://www.docker.com/).

## REST from Docker Image
### Load from built image
1. Open your terminal and switch to the path to image file.
2. Run the command:
   ```sh
   docker load -i rest_workshop.tar.gz
   ``` 
3. Verify the image has been loaded properly:
   ```sh
   docker images
   ```
   and you may find certain image repositry named as rest_workshop and with tag like dev or v1.0.

## Run REST in docker with examples in rest_workshop
### Basic Usage
In terminal, run the command to bind rest_workshop into the rest_workshop container:
```sh
docker run --rm -it -v [/path/to/rest_workshop]:/opt/rest_workshop -w /opt rest_workshop:[tag] /bin/bash 
```
this will start a rest_workshop container with example directory appearing at the /opt/rest_workshop path.
And one can simply run those input files by the command
```sh
rest -i rest_input [> output]
```

### Enhanced Visualization Support
In the new workshop release, we've added visualization capabilities based on `pymol` and other software tools 
for editing molecular stuctures, orbitals and othe rgraphical representations.

To enable these visualization features, you need to connect the Docker container to your host systems' 
X11 display server using the `-v /tmp/.X11-unit` and `-e DISPLAY` parameters:
- **For all users**:
	```sh
	docker run --rm -it -v [/path/to/rest_workshop]:/opt/rest_workshop -w /opt -v /tmp/.X11-unix:/tmp/.X11-unix:rw -e DISPLAY=$DISPLAY rest_workshop:[tag] /bin/bash 
	```
- **Additional setup for Windows users**:
	Windows users need to install and run VcXsrv X11 server:
	1. Download and install VcXsrv from https://sourceforge.net/projects/vcxsrv/
	2. Launch XLaunch from Start Menu
	3. Choose "Multiple windows" and set Display number to 0
	4. Choose "Start no client"
	5. Check "Disable access control" (important!)
	6. Finish the setup
	After VcXsrv is running, use this specific command for Windows:
	```sh
	# For Windows users, specify the variable of DISPLAY in PowerShell as first
	$DISPLAY = "host.docker.internal:0"
	```
	The key change here is to define `DISPLAY` as `host.docker.internal:0`
# Try those examples and have fun!

## Switch to previous workshop data
If you want to check the previous workshop data (e.g., data at the first conference) on the Gitee repository webpage, you can achieve this by switching the tag (标签) to like `v1.0`. If you have already cloned the repository, you can use the following commands in your terminal:
```sh
git checkout v1.0
``` 
or you may want to develop based on that previous data, run:
```sh
git checkout -b my_branch v1.0
```
This will create a new branch named `my_branch` based on the `v1.0` tag, allowing you to make changes without affecting the original data.