Tilde

Tilde is an intelligent data organizer and Python framework for computational ab initio materials science. Tilde creates systemized data repositories from the simulation logs of VASP, CRYSTAL and Quantum ESPRESSO packages. Other data formats can be added relatively easily. The folders with the log files can be scanned and the results added into a repository. A simple usecase is described in this blog post. Web-based repository GUI is separately available.

WARNING! This is NOT the working software, but rather just a proof of concept. We internally use some parts of it in our in-house projects, but in general this repository is NOT recommended for any external usage, except educating or experimenting.

Installation

System packages

build-essential
python-dev
libffi-dev
pkg-config

(-dev or -devel) must be present.

Please, set up Python virtualenv inside the Tilde folder:

virtualenv --system-site-packages tilde

Then activate virtualenv:

. bin/activate

Virtualenv should be always used while working with the codebase. Run pip install -r requirements.txt to install Python dependencies. Finally, ensure if the framework is ready:

./utils/tilde -x

Additionally, installation is covered in this blog post.

Usage

./utils/tilde --help

For example, to scan folder(s) recursively (-r), with terse print (-t), showing information on calculation metadata (-i) and convergence (-v) and adding results to a database (-a):

./utils/tilde /home/user/work1 /home/work2 -r -t -v -a -i

Other example: for the perovskite structures (shipped with Tilde), extract the distortion of the MO6-octahedra wrt cubic phase (in Euler angles). Here the -m switch invokes perovskite_tilting module (see apps folder):

./utils/tilde tilde/tests/apps/perovskite_tilting/outputs -m perovskite_tilting

GUI

Experimental GUI server is started as follows:

python utils/gui_server.py

GUI client is the separate project called Berlinium.

Testing

sh tests/run_tests.sh

Licensing

MIT

Similar projects

See this curated list.

Openness principle

Tilde adopts the principle of open data, open source code and open standards declared by an initiative group with a symbolic name Blue Obelisk.

Contact

Please, send your feedback, bugreports and feature requests via email, Twitter or GitHub.