Skip to content
This repository was archived by the owner on Aug 16, 2022. It is now read-only.

Commit 54ed7c7

Browse files
committed
README.md
1 parent 9c058fa commit 54ed7c7

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ Tilde
22
==========
33
[![DOI](https://zenodo.org/badge/18811/tilde-lab/tilde.svg)](https://zenodo.org/badge/latestdoi/18811/tilde-lab/tilde)
44

5-
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](http://www.vasp.at), [CRYSTAL](http://www.crystal.unito.it) and [Quantum ESPRESSO](http://www.quantum-espresso.org) packages. The folders with the log files can be scanned and the results added into a repository. Web-based repository GUI is [available](https://github.com/tilde-lab/berlinium).
5+
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](http://www.vasp.at), [CRYSTAL](http://www.crystal.unito.it) and [Quantum ESPRESSO](http://www.quantum-espresso.org) packages. The folders with the log files can be scanned and the results added into a repository. Web-based repository GUI is [separately available](https://github.com/tilde-lab/berlinium).
66

77
## Installation
88

9-
System packages ```build-essential python-dev libffi-dev``` (-dev or -devel) must be present. Also, Python package ```python-numpy``` should be present. [Set up Python virtualenv](https://virtualenv.readthedocs.org) inside the Tilde folder (note ```--system-site-packages``` option to access ```python-numpy```):
9+
System packages ```build-essential python-dev python-numpy libffi-dev``` (**-dev** or **-devel**) must be present. [Set up Python virtualenv](https://virtualenv.readthedocs.org) inside the Tilde folder (mind ```--system-site-packages``` option to access ```python-numpy```):
1010

1111
```shell
1212
virtualenv --system-site-packages tilde
@@ -27,21 +27,19 @@ Then test if the framework is ready:
2727
./utils/tilde.sh -x
2828
```
2929

30-
Additionally, installation is covered in [this blog post](https://blog.tilde.pro/simple-ab-initio-materials-data-mining-tutorial-6127c777dabc).
31-
3230
## Usage
3331

3432
```shell
3533
./utils/tilde.sh --help
3634
```
3735

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

4038
```shell
4139
./utils/tilde.sh /home/user/work1 /home/work2 -r -t -v -a
4240
```
4341

44-
Other example: for the perovskite structures (shipped with Tilde), extract the distortion of the MO6-octahedra wrt cubic phase (in Euler angles) and detailed calculation info:
42+
Other example: for the perovskite structures (shipped with Tilde), extract the distortion of the MO6-octahedra wrt cubic phase (in Euler angles) and detailed calculation info. Here the **-i** switch shows additional details and the **-m** switch invokes **perovskite_tilting** module (see **apps** folder):
4543

4644
```shell
4745
./utils/tilde.sh tilde/tests/apps/perovskite_tilting/outputs -m perovskite_tilting -i
@@ -109,6 +107,8 @@ Other known similar initiatives are listed below:
109107

110108
Tilde adopts the principle of open data, open source code and open standards declared by an initiative group with a symbolic name [Blue Obelisk](http://www.jcheminf.com/content/3/1/37).
111109

110+
![Blue Obelisk](https://raw.githubusercontent.com/tilde-lab/tilde/master/blue_obelisk.gif "Blue Obelisk")
111+
112112
## Contact
113113

114114
Please, send your feedback, bugreports and feature requests via [email](mailto:eb@tilde.pro), [Twitter](http://twitter.com/tildepro) or [GitHub](http://github.com/tilde-lab/tilde/issues).

blue_obelisk.gif

17.2 KB
Loading

0 commit comments

Comments
 (0)