Skip to content
Snippets Groups Projects
Commit b60e6281 authored by Michal Malý's avatar Michal Malý
Browse files

Update README

parent c6d9c79b
No related branches found
No related tags found
No related merge requests found
# WatAA # WatAA
WatAA website code Online Atlas of Protein Hydration
\ No newline at end of file
### Usage
WatAA is a dependent project of [Watlas-index](https://gitlab.cesnet.cz/madcatxster/watlas-index). It shall be deployed accordingly to the instructions provided by Watlas-index documentation.
### Configuration
In order to ensure proper functionality of WatAA, a `config.js` file must be present in WatAA's root directory. Content of the file depends on the configuration of the server where WatAA is deployed. Therefore, no `config.js` file is provided directly in the source code.
Content of the `config.js` shall be as follows:
CONFIG={
server_url: https://wataa.somewhere.org,
update_year: 2015,
update_month: 5,
update_day: 9
};
- `server_url`: URL on which WatAA is server
- `update_year`: Year of the last update of the website content
- `update_month`: Month of the last update of the website content (1 = Jan, 12 = Dec)
- `update_day`: Day of the last update of the website content
### Data
This repository provides only WatAA source code. Data are distributed separately.
Data files shall conform to the following naming scheme:
#### PDB files
PDB files shall be placed in a subdirectory named `pdbs`. Each file shall be named as follows:
{AMINOACID}_{SECONDARY-STRUCTURE}_{ROTAMER}.pdb
- `AMINOACID` Three-letter aminoacid code, e.g. `ARG`
- `SECONDARY-STRUCTURE` Either `H` or `E`
- `ROTAMER` One of `g+`, `g-` or `t`. If there are no rotamers, `NA` shall be used instead
##### Examples
- ARG_E-g-.pdb
- ALA_H_NA.pdb
#### CCP4 density map files
Density map files shall be placed in a subdirectory named `maps`. Each file shall be named as follows:
{AMINOACID}_{SECONDARY-STRUCTURE}_{ROTAMER}_clust0_water.map.ccp4
Meaning of the variables is the same as for PDB files
#### XYZ coordinate files
Coordinate files shall be placed in a subdirectory named `xyzs`. Each file shall be named as follows:
{AMINOACID}_{SECONDARY-STRUCTURE}_{ROTAMER}_W{N}.xyz
Meaning of the variables is the same as for PDB files. `N` variable is the number of the hydration site, starting from 1
<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
<path d="M1.34 0a.5.5 0 0 0 .16 1h.5v1.41c-.09.17-1.2 2.31-1.66 3.09-.16.26-.34.61-.34 1.06 0 .39.15.77.41 1.03s.64.41 1.03.41h5.13c.38 0 .74-.16 1-.41h.03c.26-.26.41-.64.41-1.03 0-.45-.19-.8-.34-1.06-.46-.78-1.57-2.92-1.66-3.09v-1.41h.5a.5.5 0 1 0 0-1h-5a.5.5 0 0 0-.09 0 .5.5 0 0 0-.06 0zm1.66 1h2v1.63l.06.09s.63 1.23 1.19 2.28h-4.5c.56-1.05 1.19-2.28 1.19-2.28l.06-.09v-1.63z"
/>
</svg>
\ No newline at end of file
<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
<path d="M.09 0c-.06 0-.09.04-.09.09v7.81c0 .05.04.09.09.09h6.81c.05 0 .09-.04.09-.09v-7.81c0-.06-.04-.09-.09-.09h-6.81zm.91 1h5v2h-5v-2zm0 3h1v1h-1v-1zm2 0h1v1h-1v-1zm2 0h1v3h-1v-3zm-4 2h1v1h-1v-1zm2 0h1v1h-1v-1z" />
</svg>
\ No newline at end of file
<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
<path d="M3 0v3h-2l3 3 3-3h-2v-3h-2zm-3 7v1h8v-1h-8z" />
</svg>
\ No newline at end of file
<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
<path d="M0 0v3h2c0 1.11-.89 2-2 2v1c1.65 0 3-1.35 3-3v-3h-3zm5 0v3h2c0 1.11-.89 2-2 2v1c1.65 0 3-1.35 3-3v-3h-3z" transform="translate(0 1)" />
</svg>
\ No newline at end of file
<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
<path d="M0 0v1l4 2 4-2v-1h-8zm0 2v4h8v-4l-4 2-4-2z" transform="translate(0 1)" />
</svg>
\ No newline at end of file
<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
<path d="M4 0c-2.21 0-4 1.79-4 4s1.79 4 4 4 4-1.79 4-4-1.79-4-4-4zm0 1c.33 0 .64.09.94.19-.21.2-.45.38-.41.56.04.18.69.13.69.5 0 .27-.42.35-.13.66.35.35-.64.98-.66 1.44-.03.83.84.97 1.53.97.42 0 .53.2.5.44-.54.77-1.46 1.25-2.47 1.25-.38 0-.73-.09-1.06-.22.22-.44-.28-1.31-.75-1.59-.23-.23-.72-.14-1-.25-.09-.27-.18-.54-.19-.84.03-.05.08-.09.16-.09.19 0 .45.38.59.34.18-.04-.74-1.31-.31-1.56.2-.12.6.39.47-.16-.12-.51.36-.28.66-.41.26-.11.45-.41.13-.59-.06-.03-.13-.1-.22-.19.45-.27.97-.44 1.53-.44zm2.31 1.09c.18.22.32.46.44.72 0 .01 0 .02 0 .03-.04.07-.11.11-.22.22-.28.28-.32-.21-.44-.31-.13-.12-.6.02-.66-.13-.07-.18.5-.42.88-.53z"
/>
</svg>
\ No newline at end of file
<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
<path d="M4 0l-4 3h1v4h2v-2h2v2h2v-4.03l1 .03-4-3z" />
</svg>
\ No newline at end of file
<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
<path d="M2.47 0c-.85 0-1.48.26-1.88.66-.4.4-.54.9-.59 1.28l1 .13c.04-.25.12-.5.31-.69.19-.19.49-.38 1.16-.38.66 0 1.02.16 1.22.34.2.18.28.4.28.66 0 .83-.34 1.06-.84 1.5-.5.44-1.16 1.08-1.16 2.25v.25h1v-.25c0-.83.31-1.06.81-1.5.5-.44 1.19-1.08 1.19-2.25 0-.48-.17-1.02-.59-1.41-.43-.39-1.07-.59-1.91-.59zm-.5 7v1h1v-1h-1z"
transform="translate(2)" />
</svg>
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment