# PACKMOL-GUI

**Repository Path**: liujiandong1996/PACKMOL-GUI

## Basic Information

- **Project Name**: PACKMOL-GUI
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-01-12
- **Last Updated**: 2025-01-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

The PACKMOL-GUI was developed utilizing Tcl/Tk, the embedded development interface for VMD extensions. This GUI requires the version 1.9.3 or above of the VMD. Additionally, Furthermore, the PACKMOL-GUI supports the periodic boundary conditions and Gaussian surfaces that were introduced in version 20.15.1 of the PACKMOL program.

INSTALLATION
============
# **1. Download and Extract Files**<br>
Users can employ auxiliary tools such as DownGit (https://downgit.github.io/#/home), GitZip (https://gitzip.org/) or the GitHub API to download the specific folder. Download options are available for various user needs.<br>
------------------------------------------------------------------------------------------<br>
**Lite‌ Version**<br>
pakmol1.0<br>
------------------------------------------------------------------------------------------<br>
**Users of Biomolecular Modeling**<br>
packmol1.0<br>
datasets-Biox<br>
------------------------------------------------------------------------------------------<br>
**Users of Metal-Organic Frameworks Modeling**<br>
packmol1.0<br>
datasets-CoRE-MOFs<br>
_**Note**_: This dataset expands the CoRE MOFs to encompass unit cell dimensions exceeding 2.4 nm and transforms them into PDB format, rendering it suitable for molecular dynamics simulations. The datasets-CoRE-MOFs file is 135 MB compressed and 3.6 GB when extracted.<br>
To extract CoRE-MOFs-PDB file, use the following commands:<br>
cat CoRE-MOFs-PDB.tar.xz.part* > temp.xz<br>
tar -xvf temp.xz<br>
------------------------------------------------------------------------------------------<br>
To prevent file path issues during installation, it is strongly recommended that users place the **packmol1.0** folder in the **YOUR-VMD-Installation-Directory/plugins/noarch/tcl**. Alternatively, users can choose any location but must use the **lappend auto_path** command to specify the absolute file path..<br>
# **2. Installation**<br>
## 2.1 Manual Installation <br>
Users are able to install PACKMOL-GUI from any location within the "Extension" menu. However, considering that PACKMOL serves as a modeling tool, it is recommended that users place it under the "Extension/Modeling" submenu for optimal organization and functionality.
Locate the VMD startup configuration file and add the following lines:<br>
__vmd_install_extension packmol packmol_tk "Modeling/PACKMOL"__<br>
The configuration file paths are:<br>
Windows: YOUR-VMD-Installation-Directory\vmd.rc<br>
Linux: YOUR-VMD-Installation-Directory/lib/vmd/.vmdrc<br>
macOS: YOUR-VMD-Installation-Directory/Contents/vmd/.vmdrc<br>
_**Note**_: If Windows users place packmol1.0 in another folder with spaces, please remember to use the escape character "\\".<br> 
For example, "lappend auto_path C:/Program Files/packmol1.0" should be written as “lappend auto_path C:/Program\ Files/packmol1.0”.<br>
## 2.2 Automated Installation <br>
We offer automated installation scripts compatible with various operating systems. Users are required to download the "packmol1.0" directory along with the "install.tcl" script. Please adhere to the instructions outlined below to successfully complete the automated installation process.<br>
1.	Download "packmol1.0" and "install.tcl".<br>
2.	Launch VMD.<br>
3.	Access the directory containing the install.tcl script either through the VMD command-line interface or by navigating to VMD Main -> Extensions -> Tk Console.<br>
    Write the following command and press ENTER:<br>
    cd "COMPLETE PATH OF install.tcl DIRECTORY"<br>
    Example: cd /home/users/ Downloads/PACKMOL-Download<br>
4.	Write the following command and press ENTER:<br>
    play install.tcl.<br>
5.	When prompted, supply the path to the packmol1.0 directory, <br>
    such as: /home/users/ Downloads/PACKMOL-Download /packmol1.0.<br>
6.	The installation process will then be completed. Please, re-launch VMD and open PACKMOL-GUI at VMD Main -> Extensions -> Modeling > PACKMOL.<br>
_**Note**_: On Linux systems, if the installation is conducted with root privileges, it is necessary for the user to specify the path to the .vmdrc file. Compatibility has been evaluated with Windows versions 7, 10, and 11; macOS Mojave version 10.14 (with the caveat that macOS version 10.15 no longer supports 32-bit applications); and CentOS version 7.0 systems.<br><br>
**Figure 1.** The interactive and automated procedure for installation.
![config-1](https://github.com/MSM-RAD-X-VMD-Plugin/PACKMOL-GUI/blob/main/annotated-recording-examples/install.gif)<br><br>
# 3. Launch VMD<br>
After starting VMD, you can access the PACKMOL-GUI via the Extensions -> Modeling -> PACKMOL submenu in the VMD Main menu.
# 4. Configuring the PACKMOL Path and Working Directory
Upon successful initialization of the PACKMOL-GUI, it is imperative for users to configure the program path for PACKMOL and establish the current working directory. To achieve this, users should select the "browse" button adjacent to the PACKMOL directory label, navigate to the location of the PACKMOL program, select it, and double-click to finalize the path configuration. For specifying the output file path of PACKMOL, users may click the "browse" button next to the "output directory" label and select an appropriate working directory that aligns with their specific requirements. <br><br>
**Figure 2.** Configuring the PACKMOL Path
![config-1](https://github.com/MSM-RAD-X-VMD-Plugin/PACKMOL-GUI/blob/main/annotated-recording-examples/sc-1-Linux.jpg)<br><br>
**Figure 3.** Configuring the Working Directory
![config-2](https://github.com/MSM-RAD-X-VMD-Plugin/PACKMOL-GUI/blob/main/annotated-recording-examples/SC-2-Liunx.jpg)