Wiki

Version 12 (Carles Marti, 10/02/2021 15:49)

1 6 Carles Marti
h1. DockOnSurf
2 5 Carles Marti
3 6 Carles Marti
4 5 Carles Marti
DockOnSurf is a program to automatically find the most stable geometry for molecules
5 5 Carles Marti
on surfaces.
6 5 Carles Marti
7 5 Carles Marti
webpage: https://forge.cbp.ens-lyon.fr/redmine/projects/dockonsurf
8 5 Carles Marti
9 5 Carles Marti
10 6 Carles Marti
h1. Requirements:
11 5 Carles Marti
12 10 Carles Marti
* "Python":http://www.python.org/ >= 3.6
13 10 Carles Marti
* "Matplotlib":https://matplotlib.org ~= 3.2.1
14 10 Carles Marti
* "NumPy":http://docs.scipy.org/doc/numpy/reference/ >= 1.16.6
15 10 Carles Marti
* "RDKit":https://rdkit.org/ ~= 2019.9.3
16 10 Carles Marti
* "scikit-learn":https://scikit-learn.org/ ~= 0.23.1
17 10 Carles Marti
* "HDBSCAN":https://hdbscan.readthedocs.io/en/latest/basic_hdbscan.html ~= 0.8.26
18 10 Carles Marti
* "ASE":https://wiki.fysik.dtu.dk/ase/ ~= 3.19.1
19 10 Carles Marti
* "NetworkX":https://networkx.org/ >= 2.4
20 10 Carles Marti
* "python-daemon":https://pypi.org/project/python-daemon/ ~= 2.2.4
21 10 Carles Marti
* "pymatgen":https://pymatgen.org/ ~= 2020.11.11
22 10 Carles Marti
* "pycp2k":https://github.com/SINGROUP/pycp2k ~= 0.2.2
23 5 Carles Marti
24 5 Carles Marti
25 6 Carles Marti
h1. Installation:
26 6 Carles Marti
27 7 Carles Marti
Download the @dockonsurf@ directory and place it somwhere in your computer:
28 7 Carles Marti
<pre>
29 5 Carles Marti
git clone http://forge.cbp.ens-lyon.fr/git/dockonsurf
30 7 Carles Marti
</pre>
31 1 Carles Marti
32 11 Carles Marti
Assuming you download it in your @$HOME@ directory, add @$HOME/dockonsurf@ to your @PATH@ variable:
33 11 Carles Marti
<pre>
34 11 Carles Marti
PATH="$PATH:$HOMEdockonsurf/"
35 11 Carles Marti
</pre>
36 11 Carles Marti
37 12 Carles Marti
and ensure all python libraries listed in Requirements are installed and available.
38 5 Carles Marti
39 5 Carles Marti
40 6 Carles Marti
h1. Testing
41 5 Carles Marti
42 5 Carles Marti
(To be done)
43 1 Carles Marti
44 5 Carles Marti
45 6 Carles Marti
h1. Contact 
46 5 Carles Marti
47 5 Carles Marti
Submit an issue in:
48 5 Carles Marti
https://forge.cbp.ens-lyon.fr/redmine/projects/dockonsurf/issues
49 5 Carles Marti
50 5 Carles Marti
Please send us bug-reports, patches, code, ideas and questions.
51 5 Carles Marti
52 5 Carles Marti
53 6 Carles Marti
h1. Example
54 5 Carles Marti
55 5 Carles Marti
(To be done)