Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 1.97 KB

README.md

File metadata and controls

63 lines (45 loc) · 1.97 KB
Raw

LdG-sim

license tag code-size repo-size

An implementation of Landau-de Gennes's model of nematic liquid crystal simulation

Download

git clone https://github.com/tings0802/LdG-sim.git

Prerequisites

  • C compiler that supports C99 standard
  • GNU Make
  • Python 3.6 or later
  • Numpy
  • Matplotlib

After cloning the LdG-sim repository, you can use the following command to install the SDKs and packages of dependencies.

With Package manager

For Ubuntu 18.04, Debain 10, or later versions, directly type the following command to install GCC, Make, Python, and pip:

sudo apt update && sudo apt install -y build-essential python3 python3-pip

You can check the versions of Python and pip with the following commands:

python3 --version
pip3 --version

From source code

For older versions of operating system or users that doesn't have the root permission to use package manager, You should build dependencies from source code.

If you don't have pip, see this documentation to install pip.

pip3 install -r requirements.txt

Installation

Navigate to the LdG-sim folder, and then make it.

make

Usage

License

LdG-sim is released under the MIT License.
Please cite the following paper if you use this package for published research:
M. Ravnik, S. Žumer, Liquid Crystals 36, 1201-1214 (2009)