Statistiques
| Branche: | Tag: | Révision :

dockonsurf / README.md @ 96d422c7

Historique | Voir | Annoter | Télécharger (1,15 ko)

1 6bbda834 Carles Martí
DockOnSurf
2 6bbda834 Carles Martí
==========
3 6bbda834 Carles Martí
4 6bbda834 Carles Martí
DockOnSurf is a ode to systematically find the most stable geometry for molecules
5 6bbda834 Carles Martí
on surfaces.
6 6bbda834 Carles Martí
7 6bbda834 Carles Martí
webpage: https://forge.cbp.ens-lyon.fr/redmine/projects/dockonsurf
8 6bbda834 Carles Martí
9 6bbda834 Carles Martí
10 6bbda834 Carles Martí
Requirements:
11 6bbda834 Carles Martí
-------------
12 6bbda834 Carles Martí
13 2164e2f3 Carles Martí
* [Python](http://www.python.org/) >= 3.6
14 2164e2f3 Carles Martí
* [Matplotlib](https://matplotlib.org) ~= 3.2.1
15 2164e2f3 Carles Martí
* [NumPy](http://docs.scipy.org/doc/numpy/reference/) >= 1.16.6
16 2164e2f3 Carles Martí
* [RDKit](https://rdkit.org/) ~= 2019.9.3
17 2164e2f3 Carles Martí
* [scikit-learn](https://scikit-learn.org/) ~= 0.23.1
18 2164e2f3 Carles Martí
* [HDBSCAN](https://hdbscan.readthedocs.io/en/latest/basic_hdbscan.html) ~= 0.8.26
19 2164e2f3 Carles Martí
* [ASE](https://wiki.fysik.dtu.dk/ase/) ~= 3.19.1
20 2164e2f3 Carles Martí
* [NetworkX](https://networkx.org/) >= 2.4
21 2164e2f3 Carles Martí
* [python-daemon](https://pypi.org/project/python-daemon/) ~= 2.2.4
22 2164e2f3 Carles Martí
* [pymatgen](https://pymatgen.org/) ~= 2020.11.11
23 2164e2f3 Carles Martí
* [pycp2k](https://github.com/SINGROUP/pycp2k) ~= 0.2.2
24 6bbda834 Carles Martí
25 6bbda834 Carles Martí
26 6bbda834 Carles Martí
Installation:
27 6bbda834 Carles Martí
-------------
28 6bbda834 Carles Martí
29 6bbda834 Carles Martí
Add ``~/dockonsurf`` to your $PATH (assuming ``~/dockonsurf`` is where your DockOnSurf folder is).
30 6bbda834 Carles Martí
31 6bbda834 Carles Martí
32 6bbda834 Carles Martí
Testing
33 6bbda834 Carles Martí
-------
34 6bbda834 Carles Martí
35 6bbda834 Carles Martí
(To be done)
36 6bbda834 Carles Martí
37 6bbda834 Carles Martí
38 6bbda834 Carles Martí
Contact 
39 6bbda834 Carles Martí
-------
40 6bbda834 Carles Martí
41 6bbda834 Carles Martí
Submit an issue in:
42 6bbda834 Carles Martí
https://forge.cbp.ens-lyon.fr/redmine/projects/dockonsurf/issues
43 6bbda834 Carles Martí
44 6bbda834 Carles Martí
Please send us bug-reports, patches, code, ideas and questions.
45 6bbda834 Carles Martí
46 6bbda834 Carles Martí
47 6bbda834 Carles Martí
Example
48 6bbda834 Carles Martí
-------
49 6bbda834 Carles Martí
50 2164e2f3 Carles Martí
(To be done)