Wiki
Version 6 (Carles Marti, 10/02/2021 15:38)
| 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 | 5 | Carles Marti | * [Python](http://www.python.org/) >= 3.6 |
| 13 | 5 | Carles Marti | * [Matplotlib](https://matplotlib.org) ~= 3.2.1 |
| 14 | 5 | Carles Marti | * [NumPy](http://docs.scipy.org/doc/numpy/reference/) >= 1.16.6 |
| 15 | 5 | Carles Marti | * [RDKit](https://rdkit.org/) ~= 2019.9.3 |
| 16 | 5 | Carles Marti | * [scikit-learn](https://scikit-learn.org/) ~= 0.23.1 |
| 17 | 5 | Carles Marti | * [HDBSCAN](https://hdbscan.readthedocs.io/en/latest/basic_hdbscan.html) ~= 0.8.26 |
| 18 | 5 | Carles Marti | * [ASE](https://wiki.fysik.dtu.dk/ase/) ~= 3.19.1 |
| 19 | 5 | Carles Marti | * [NetworkX](https://networkx.org/) >= 2.4 |
| 20 | 5 | Carles Marti | * [python-daemon](https://pypi.org/project/python-daemon/) ~= 2.2.4 |
| 21 | 1 | Carles Marti | * [pymatgen](https://pymatgen.org/) ~= 2020.11.11 |
| 22 | 5 | 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 | 5 | Carles Marti | Download the ``dockonsurf`` directory and place it somwhere in your computer: |
| 28 | 5 | Carles Marti | ``` |
| 29 | 5 | Carles Marti | git clone http://forge.cbp.ens-lyon.fr/git/dockonsurf |
| 30 | 5 | Carles Marti | ``` |
| 31 | 1 | Carles Marti | |
| 32 | 5 | Carles Marti | Assuming you download it in your ``HOME``directory, add ``$HOME/dockonsurf`` to your ``PATH`` variable (assuming ``~/dockonsurf`` |
| 33 | 5 | Carles Marti | is where your DockOnSurf folder is) and ensure all python libraries listed |
| 34 | 1 | Carles Marti | in Requirements are installed and available. |
| 35 | 5 | Carles Marti | |
| 36 | 5 | Carles Marti | |
| 37 | 6 | Carles Marti | h1. Testing |
| 38 | 5 | Carles Marti | |
| 39 | 5 | Carles Marti | (To be done) |
| 40 | 1 | Carles Marti | |
| 41 | 5 | Carles Marti | |
| 42 | 6 | Carles Marti | h1. Contact |
| 43 | 5 | Carles Marti | |
| 44 | 5 | Carles Marti | Submit an issue in: |
| 45 | 5 | Carles Marti | https://forge.cbp.ens-lyon.fr/redmine/projects/dockonsurf/issues |
| 46 | 5 | Carles Marti | |
| 47 | 5 | Carles Marti | Please send us bug-reports, patches, code, ideas and questions. |
| 48 | 5 | Carles Marti | |
| 49 | 5 | Carles Marti | |
| 50 | 6 | Carles Marti | h1. Example |
| 51 | 5 | Carles Marti | |
| 52 | 5 | Carles Marti | (To be done) |