Révision b02197ea README.md

b/README.md
6 6

  
7 7
webpage: https://forge.cbp.ens-lyon.fr/redmine/projects/dockonsurf
8 8

  
9
Features
10
--------
11
* Generate a handful of adsorbate-surface structures by 
12
  combining:
13
  * surface sites
14
  * adsorbate's anchoring points
15
  * conformers
16
  * orientations
17
  * probe dissociation of acidic H
18
  
19
* Guess the direction where to place the adsorbate. 
20
  Useful for nanoparticles or stepped/kinked surfaces.
21
  
22
* Sample different orientations efficiently by using internal angles.
23

  
24
* Detect and correct atomic clashes.
25

  
26
* Optimize the geometry of the generated structures using CP2K or VASP.
27
  
28
* Submit jobs to your computing center and check if they have finished normally.
29

  
30
* Track progress by logging all events on a log file.
31

  
32
* Customize the execution by changing chemically meaningful  the edition of a simple input file.
33

  
9 34

  
10 35
Installation:
11 36
-------------
......
46 71
* [pymatgen](https://pymatgen.org/) ~= 2020.11.11
47 72
* [pycp2k](https://github.com/SINGROUP/pycp2k) ~= 0.2.2
48 73

  
74
Example
75
-------
76
Execute DockOnSurf by typing
77

  
78
    dockonsurf.py -i dockonsurf.inp
79

  
80
where `dockonsurf.inp` is the dockonsurf input file. See a sample [here](https://forge.cbp.ens-lyon.fr/redmine/projects/dockonsurf/repository/revisions/master/entry/examples/dockonsurf.inp).
81

  
49 82
Testing
50 83
-------
51 84

  
52 85
(To be done)
53 86

  
54 87

  
55
Contact 
88
Contact/Contribute 
56 89
-------
57 90

  
58 91
Submit an issue in:
......
60 93

  
61 94
Please send us bug-reports, patches, code, ideas and questions.
62 95

  
96
License
97
-
63 98

  
64
Example
65
-------
66

  
67
(To be done)
68

  
99
DockOnSurf is licensed under the MIT license.

Formats disponibles : Unified diff