2. Download and Installation

2.1. Download

The binary executable file for CryDisGen supports major Linux-based operating systems, including Ubuntu, Debian, CentOS, Fedora, and openSUSE, and is available for direct download from GitHub

---

These are the files and subdirectories in the CryDisGen distribution:

Directory	Content
README	A brief description of the CryDisGen package
LICENSE	GNU General Public License (GPL)
bin	The binary executable file for CryDisGen is stored here
doc	Documentation of CryDisGen
examples	Examples of dislocation structures created by CryDisGen
src	C++ source code
tools	Auxiliary tools for use with CryDisGen

2.2. Installation

After downloading the binary file and saving it as CryDisGen, open a Terminal window, navigate to the directory where CryDisGen is saved, and run the following command:

# bash
chmod +x CryDisGen

If it is needed, the path to CryDisGen can be added to the operating system’s enviromental variable $PATH. This allows CryDisGen to be executed anywhere without explicitly specifying its full path.

Assuming CryDisGen is saved in a folder within the home directory, such as ~/myfolder, we can add its path to the enviromental varialbe $PATH by appending the following line to the ~/.bashrc:

# bash
export PATH=~/myfolder:$PATH

After completing the steps above, CryDisGen is sucessfully installed.

2.3. Compilation

The executable can be directly compiled from the source code as well. Before compiling, make sure that GNU Make and a compatible C++ compiler are installed and properly configured on the system. The compilation process does not require any additional configuration under the default settings.

To compile the source files, navigate to the ./src directory in the terminal and run GNU Make by typing:

# bash
make

GNU Make will automatically read the Makefile in the ./src directory and compile the required source files. If the compilation completes successfully, an executable named CryDisGen will be produced in the current directory.

You can verify that the executable has been successfully generated by listing the contents of the directory:

# bash
ls

The executable can then be run directly from the terminal.

If compilation fails, check the error messages displayed in the terminal. In particular, make sure that a compatible C++ compiler is installed, all required dependencies are available, and the source files are compiled from the correct ./src directory.