cavefiller 0.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- cavefiller-0.2.0/LICENSE +201 -0
- cavefiller-0.2.0/PKG-INFO +225 -0
- cavefiller-0.2.0/README.md +206 -0
- cavefiller-0.2.0/cavefiller/__init__.py +3 -0
- cavefiller-0.2.0/cavefiller/cavity_finder.py +114 -0
- cavefiller-0.2.0/cavefiller/cavity_selector.py +120 -0
- cavefiller-0.2.0/cavefiller/cli.py +145 -0
- cavefiller-0.2.0/cavefiller/water_filler.py +603 -0
- cavefiller-0.2.0/cavefiller.egg-info/PKG-INFO +225 -0
- cavefiller-0.2.0/cavefiller.egg-info/SOURCES.txt +15 -0
- cavefiller-0.2.0/cavefiller.egg-info/dependency_links.txt +1 -0
- cavefiller-0.2.0/cavefiller.egg-info/entry_points.txt +2 -0
- cavefiller-0.2.0/cavefiller.egg-info/requires.txt +10 -0
- cavefiller-0.2.0/cavefiller.egg-info/top_level.txt +1 -0
- cavefiller-0.2.0/pyproject.toml +42 -0
- cavefiller-0.2.0/setup.cfg +4 -0
- cavefiller-0.2.0/tests/test_cavefiller.py +237 -0
cavefiller-0.2.0/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: cavefiller
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: A tool to find and fill protein cavities with water molecules using KVFinder and Packmol
|
|
5
|
+
Author: CaveFiller Contributors
|
|
6
|
+
Requires-Python: >=3.8
|
|
7
|
+
Description-Content-Type: text/markdown
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
Requires-Dist: typer>=0.9.0
|
|
10
|
+
Requires-Dist: pykvfinder>=0.6.0
|
|
11
|
+
Requires-Dist: rdkit>=2022.9.1
|
|
12
|
+
Requires-Dist: numpy>=1.20.0
|
|
13
|
+
Requires-Dist: biopython>=1.79
|
|
14
|
+
Provides-Extra: dev
|
|
15
|
+
Requires-Dist: pytest>=7.0.0; extra == "dev"
|
|
16
|
+
Requires-Dist: black>=22.0.0; extra == "dev"
|
|
17
|
+
Requires-Dist: ruff>=0.1.0; extra == "dev"
|
|
18
|
+
Dynamic: license-file
|
|
19
|
+
|
|
20
|
+
# CaveFiller
|
|
21
|
+
|
|
22
|
+
A Python tool to find and fill protein cavities with water molecules using KVFinder, Monte Carlo sampling, and RDKit-based explicit water generation.
|
|
23
|
+
|
|
24
|
+
## Features
|
|
25
|
+
|
|
26
|
+
- **Cavity Detection**: Uses pyKVFinder to detect cavities in protein structures
|
|
27
|
+
- **Interactive Selection**: Select specific cavities to fill with user-defined water counts
|
|
28
|
+
- **Monte Carlo Sampling**: Places water molecules using Monte Carlo sampling with clash detection
|
|
29
|
+
- **Explicit Waters**: Builds full H-O-H waters with RDKit (including hydrogens)
|
|
30
|
+
- **CLI Interface**: Easy-to-use command-line interface built with Typer
|
|
31
|
+
|
|
32
|
+
## Installation
|
|
33
|
+
|
|
34
|
+
### Prerequisites
|
|
35
|
+
|
|
36
|
+
1. **Python**: Python 3.8 or higher
|
|
37
|
+
|
|
38
|
+
### Install CaveFiller
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
# Clone the repository
|
|
42
|
+
git clone https://github.com/Desperadus/CaveFiller.git
|
|
43
|
+
cd CaveFiller
|
|
44
|
+
|
|
45
|
+
# Install the package
|
|
46
|
+
pip install -e .
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Usage
|
|
50
|
+
|
|
51
|
+
### Basic Usage
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
cavefiller protein.pdb
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
This will:
|
|
58
|
+
1. Detect cavities in `protein.pdb`
|
|
59
|
+
2. Display a list of found cavities with their volumes and areas
|
|
60
|
+
3. Prompt you to select which cavities to fill
|
|
61
|
+
4. Prompt you for the number of water molecules per cavity
|
|
62
|
+
5. Place waters using Monte Carlo sampling with clash detection
|
|
63
|
+
6. Build explicit RDKit H-O-H waters and export a combined PDB
|
|
64
|
+
7. Save the output to `./output/protein_filled.pdb`
|
|
65
|
+
|
|
66
|
+
### Command-line Options
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
cavefiller [PROTEIN_FILE] [OPTIONS]
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
**Arguments:**
|
|
73
|
+
- `PROTEIN_FILE`: Path to the protein PDB file (required)
|
|
74
|
+
|
|
75
|
+
**Options:**
|
|
76
|
+
- `--output-dir PATH`: Directory to save output files (default: `./output`)
|
|
77
|
+
- `--probe-in FLOAT`: Probe In radius for cavity detection in Ångströms (default: 1.4)
|
|
78
|
+
- `--probe-out FLOAT`: Probe Out radius for cavity detection in Ångströms (default: 4.0)
|
|
79
|
+
- `--volume-cutoff FLOAT`: Minimum cavity volume to consider in Ų (default: 5.0)
|
|
80
|
+
- `--auto-select`: Automatically select all cavities without user interaction
|
|
81
|
+
- `--cavity-ids TEXT`: Comma-separated list of cavity IDs to fill (e.g., '1,2,3')
|
|
82
|
+
- `--waters-per-cavity TEXT`: Comma-separated list of water counts (e.g., '10,15,20'), must match cavity-ids order
|
|
83
|
+
- `--optimize-mmff94 / --no-optimize-mmff94`: Enable/disable MMFF94 with protein fixed (default: enabled)
|
|
84
|
+
- `--mmff-max-iterations INTEGER`: Max MMFF94 iterations (default: 300)
|
|
85
|
+
|
|
86
|
+
Recommended usage:
|
|
87
|
+
- Prefer interactive/manual cavity and water-count selection over `--auto-select`. Auto-selection often overfills cavities with too many waters.
|
|
88
|
+
- Keep `--optimize-mmff94` enabled (recommended) to refine water placement after Monte Carlo sampling.
|
|
89
|
+
|
|
90
|
+
### Examples
|
|
91
|
+
|
|
92
|
+
**Interactive cavity and water selection:**
|
|
93
|
+
```bash
|
|
94
|
+
cavefiller protein.pdb --output-dir results
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
**Auto-select all cavities with default water counts (not generally recommended):**
|
|
98
|
+
```bash
|
|
99
|
+
cavefiller protein.pdb --auto-select
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
**Fill specific cavities with specific water counts:**
|
|
103
|
+
```bash
|
|
104
|
+
cavefiller protein.pdb --cavity-ids "1,3,5" --waters-per-cavity "10,15,20"
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
**Custom cavity detection parameters:**
|
|
108
|
+
```bash
|
|
109
|
+
cavefiller protein.pdb --probe-in 1.2 --probe-out 5.0 --volume-cutoff 10.0
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Workflow
|
|
113
|
+
|
|
114
|
+
1. **Cavity Detection**: The tool uses pyKVFinder to detect cavities in the input protein structure
|
|
115
|
+
2. **Cavity Analysis**: Displays information about detected cavities (ID, volume, surface area)
|
|
116
|
+
3. **Cavity Selection**:
|
|
117
|
+
- Interactive mode: User selects cavities and specifies water counts
|
|
118
|
+
- Auto mode: All cavities are selected with automatic water count estimation
|
|
119
|
+
- Command-line mode: Specific cavities and water counts are pre-selected
|
|
120
|
+
4. **Water Placement**:
|
|
121
|
+
- Monte Carlo sampling places waters randomly in cavity
|
|
122
|
+
- Clash detection validates each position against protein atoms and other waters
|
|
123
|
+
- Uses Van der Waals radii for distance calculations
|
|
124
|
+
5. **RDKit Water Construction**:
|
|
125
|
+
- Explicit H-O-H waters are generated with ideal geometry
|
|
126
|
+
- Waters include hydrogens and proper HOH residue records in the output PDB
|
|
127
|
+
|
|
128
|
+
## Algorithm Details
|
|
129
|
+
|
|
130
|
+
### Monte Carlo Sampling
|
|
131
|
+
- Samples around cavity grid points with small local jitter
|
|
132
|
+
- Validates position stays near cavity voxels (< 0.7 Å from a grid point)
|
|
133
|
+
- Checks for clashes with protein atoms (minimum distance based on VDW radii)
|
|
134
|
+
- Checks for clashes with other waters (minimum 2.7 Å separation)
|
|
135
|
+
- Attempts up to 500 placements per water molecule
|
|
136
|
+
|
|
137
|
+
### Clash Detection
|
|
138
|
+
- Uses Van der Waals radii for different atom types (H, C, N, O, S, P)
|
|
139
|
+
- Minimum water-protein distance: 2.35 Å
|
|
140
|
+
- Minimum water-water distance: 2.7 Å
|
|
141
|
+
- Tolerance of 0.5 Å for VDW overlap
|
|
142
|
+
|
|
143
|
+
### RDKit Water Geometry
|
|
144
|
+
- Creates proper H-O-H geometry for each water
|
|
145
|
+
- Writes explicit HOH residues (O, H1, H2) into output PDB
|
|
146
|
+
|
|
147
|
+
## Output
|
|
148
|
+
|
|
149
|
+
The tool generates the following files in the output directory:
|
|
150
|
+
|
|
151
|
+
- `protein_filled.pdb`: Protein structure with explicit water molecules in selected cavities
|
|
152
|
+
|
|
153
|
+
## Dependencies
|
|
154
|
+
|
|
155
|
+
- **typer**: CLI framework
|
|
156
|
+
- **pyKVFinder**: Cavity detection
|
|
157
|
+
- **rdkit**: Molecular manipulation and explicit water generation
|
|
158
|
+
- **numpy**: Numerical operations
|
|
159
|
+
- **biopython**: PDB file handling
|
|
160
|
+
|
|
161
|
+
## Development
|
|
162
|
+
|
|
163
|
+
### Running Tests
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
pip install -e ".[dev]"
|
|
167
|
+
pytest
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### Code Formatting
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
black cavefiller/
|
|
174
|
+
ruff check cavefiller/
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Automated CI/CD and PyPI Publishing
|
|
178
|
+
|
|
179
|
+
This repository includes GitHub Actions workflow at `.github/workflows/ci-cd.yml` that:
|
|
180
|
+
- Runs `pytest` on every push to `main`
|
|
181
|
+
- Runs `pytest` on every pull request targeting `main`
|
|
182
|
+
- Builds package distributions after tests pass
|
|
183
|
+
- Publishes to PyPI only when you push a version tag like `v0.1.1`
|
|
184
|
+
|
|
185
|
+
#### One-time setup for automatic PyPI publishing
|
|
186
|
+
|
|
187
|
+
1. Create a PyPI account at https://pypi.org and create your project once (or publish once manually so the name exists).
|
|
188
|
+
2. In PyPI, open your project settings and add a **Trusted Publisher**:
|
|
189
|
+
- Owner: your GitHub username/org
|
|
190
|
+
- Repository: `Desperadus/CaveFiller`
|
|
191
|
+
- Workflow name: `CI/CD`
|
|
192
|
+
- Environment: leave empty (unless you choose to use one)
|
|
193
|
+
3. In GitHub, ensure Actions are enabled for the repository.
|
|
194
|
+
|
|
195
|
+
No PyPI API token secret is needed when using Trusted Publishing.
|
|
196
|
+
|
|
197
|
+
#### Releasing a new version
|
|
198
|
+
|
|
199
|
+
1. Bump version in both:
|
|
200
|
+
- `pyproject.toml` (`project.version`)
|
|
201
|
+
- `cavefiller/__init__.py` (`__version__`)
|
|
202
|
+
2. Commit and push to `main`.
|
|
203
|
+
3. Create and push a matching tag:
|
|
204
|
+
|
|
205
|
+
```bash
|
|
206
|
+
git tag v0.1.1
|
|
207
|
+
git push origin v0.1.1
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
The workflow validates that the tag matches `pyproject.toml` (for example, tag `v0.1.1` must match version `0.1.1`) before publishing.
|
|
211
|
+
|
|
212
|
+
## License
|
|
213
|
+
|
|
214
|
+
See LICENSE file for details.
|
|
215
|
+
|
|
216
|
+
## Citation
|
|
217
|
+
|
|
218
|
+
If you use CaveFiller in your research, please cite:
|
|
219
|
+
|
|
220
|
+
- pyKVFinder: Guerra et al. (2020) BMC Bioinformatics
|
|
221
|
+
- RDKit: RDKit: Open-source cheminformatics; http://www.rdkit.org
|
|
222
|
+
|
|
223
|
+
## Contributing
|
|
224
|
+
|
|
225
|
+
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
# CaveFiller
|
|
2
|
+
|
|
3
|
+
A Python tool to find and fill protein cavities with water molecules using KVFinder, Monte Carlo sampling, and RDKit-based explicit water generation.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Cavity Detection**: Uses pyKVFinder to detect cavities in protein structures
|
|
8
|
+
- **Interactive Selection**: Select specific cavities to fill with user-defined water counts
|
|
9
|
+
- **Monte Carlo Sampling**: Places water molecules using Monte Carlo sampling with clash detection
|
|
10
|
+
- **Explicit Waters**: Builds full H-O-H waters with RDKit (including hydrogens)
|
|
11
|
+
- **CLI Interface**: Easy-to-use command-line interface built with Typer
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
### Prerequisites
|
|
16
|
+
|
|
17
|
+
1. **Python**: Python 3.8 or higher
|
|
18
|
+
|
|
19
|
+
### Install CaveFiller
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
# Clone the repository
|
|
23
|
+
git clone https://github.com/Desperadus/CaveFiller.git
|
|
24
|
+
cd CaveFiller
|
|
25
|
+
|
|
26
|
+
# Install the package
|
|
27
|
+
pip install -e .
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Usage
|
|
31
|
+
|
|
32
|
+
### Basic Usage
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
cavefiller protein.pdb
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
This will:
|
|
39
|
+
1. Detect cavities in `protein.pdb`
|
|
40
|
+
2. Display a list of found cavities with their volumes and areas
|
|
41
|
+
3. Prompt you to select which cavities to fill
|
|
42
|
+
4. Prompt you for the number of water molecules per cavity
|
|
43
|
+
5. Place waters using Monte Carlo sampling with clash detection
|
|
44
|
+
6. Build explicit RDKit H-O-H waters and export a combined PDB
|
|
45
|
+
7. Save the output to `./output/protein_filled.pdb`
|
|
46
|
+
|
|
47
|
+
### Command-line Options
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
cavefiller [PROTEIN_FILE] [OPTIONS]
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
**Arguments:**
|
|
54
|
+
- `PROTEIN_FILE`: Path to the protein PDB file (required)
|
|
55
|
+
|
|
56
|
+
**Options:**
|
|
57
|
+
- `--output-dir PATH`: Directory to save output files (default: `./output`)
|
|
58
|
+
- `--probe-in FLOAT`: Probe In radius for cavity detection in Ångströms (default: 1.4)
|
|
59
|
+
- `--probe-out FLOAT`: Probe Out radius for cavity detection in Ångströms (default: 4.0)
|
|
60
|
+
- `--volume-cutoff FLOAT`: Minimum cavity volume to consider in Ų (default: 5.0)
|
|
61
|
+
- `--auto-select`: Automatically select all cavities without user interaction
|
|
62
|
+
- `--cavity-ids TEXT`: Comma-separated list of cavity IDs to fill (e.g., '1,2,3')
|
|
63
|
+
- `--waters-per-cavity TEXT`: Comma-separated list of water counts (e.g., '10,15,20'), must match cavity-ids order
|
|
64
|
+
- `--optimize-mmff94 / --no-optimize-mmff94`: Enable/disable MMFF94 with protein fixed (default: enabled)
|
|
65
|
+
- `--mmff-max-iterations INTEGER`: Max MMFF94 iterations (default: 300)
|
|
66
|
+
|
|
67
|
+
Recommended usage:
|
|
68
|
+
- Prefer interactive/manual cavity and water-count selection over `--auto-select`. Auto-selection often overfills cavities with too many waters.
|
|
69
|
+
- Keep `--optimize-mmff94` enabled (recommended) to refine water placement after Monte Carlo sampling.
|
|
70
|
+
|
|
71
|
+
### Examples
|
|
72
|
+
|
|
73
|
+
**Interactive cavity and water selection:**
|
|
74
|
+
```bash
|
|
75
|
+
cavefiller protein.pdb --output-dir results
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
**Auto-select all cavities with default water counts (not generally recommended):**
|
|
79
|
+
```bash
|
|
80
|
+
cavefiller protein.pdb --auto-select
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
**Fill specific cavities with specific water counts:**
|
|
84
|
+
```bash
|
|
85
|
+
cavefiller protein.pdb --cavity-ids "1,3,5" --waters-per-cavity "10,15,20"
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
**Custom cavity detection parameters:**
|
|
89
|
+
```bash
|
|
90
|
+
cavefiller protein.pdb --probe-in 1.2 --probe-out 5.0 --volume-cutoff 10.0
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Workflow
|
|
94
|
+
|
|
95
|
+
1. **Cavity Detection**: The tool uses pyKVFinder to detect cavities in the input protein structure
|
|
96
|
+
2. **Cavity Analysis**: Displays information about detected cavities (ID, volume, surface area)
|
|
97
|
+
3. **Cavity Selection**:
|
|
98
|
+
- Interactive mode: User selects cavities and specifies water counts
|
|
99
|
+
- Auto mode: All cavities are selected with automatic water count estimation
|
|
100
|
+
- Command-line mode: Specific cavities and water counts are pre-selected
|
|
101
|
+
4. **Water Placement**:
|
|
102
|
+
- Monte Carlo sampling places waters randomly in cavity
|
|
103
|
+
- Clash detection validates each position against protein atoms and other waters
|
|
104
|
+
- Uses Van der Waals radii for distance calculations
|
|
105
|
+
5. **RDKit Water Construction**:
|
|
106
|
+
- Explicit H-O-H waters are generated with ideal geometry
|
|
107
|
+
- Waters include hydrogens and proper HOH residue records in the output PDB
|
|
108
|
+
|
|
109
|
+
## Algorithm Details
|
|
110
|
+
|
|
111
|
+
### Monte Carlo Sampling
|
|
112
|
+
- Samples around cavity grid points with small local jitter
|
|
113
|
+
- Validates position stays near cavity voxels (< 0.7 Å from a grid point)
|
|
114
|
+
- Checks for clashes with protein atoms (minimum distance based on VDW radii)
|
|
115
|
+
- Checks for clashes with other waters (minimum 2.7 Å separation)
|
|
116
|
+
- Attempts up to 500 placements per water molecule
|
|
117
|
+
|
|
118
|
+
### Clash Detection
|
|
119
|
+
- Uses Van der Waals radii for different atom types (H, C, N, O, S, P)
|
|
120
|
+
- Minimum water-protein distance: 2.35 Å
|
|
121
|
+
- Minimum water-water distance: 2.7 Å
|
|
122
|
+
- Tolerance of 0.5 Å for VDW overlap
|
|
123
|
+
|
|
124
|
+
### RDKit Water Geometry
|
|
125
|
+
- Creates proper H-O-H geometry for each water
|
|
126
|
+
- Writes explicit HOH residues (O, H1, H2) into output PDB
|
|
127
|
+
|
|
128
|
+
## Output
|
|
129
|
+
|
|
130
|
+
The tool generates the following files in the output directory:
|
|
131
|
+
|
|
132
|
+
- `protein_filled.pdb`: Protein structure with explicit water molecules in selected cavities
|
|
133
|
+
|
|
134
|
+
## Dependencies
|
|
135
|
+
|
|
136
|
+
- **typer**: CLI framework
|
|
137
|
+
- **pyKVFinder**: Cavity detection
|
|
138
|
+
- **rdkit**: Molecular manipulation and explicit water generation
|
|
139
|
+
- **numpy**: Numerical operations
|
|
140
|
+
- **biopython**: PDB file handling
|
|
141
|
+
|
|
142
|
+
## Development
|
|
143
|
+
|
|
144
|
+
### Running Tests
|
|
145
|
+
|
|
146
|
+
```bash
|
|
147
|
+
pip install -e ".[dev]"
|
|
148
|
+
pytest
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### Code Formatting
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
black cavefiller/
|
|
155
|
+
ruff check cavefiller/
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Automated CI/CD and PyPI Publishing
|
|
159
|
+
|
|
160
|
+
This repository includes GitHub Actions workflow at `.github/workflows/ci-cd.yml` that:
|
|
161
|
+
- Runs `pytest` on every push to `main`
|
|
162
|
+
- Runs `pytest` on every pull request targeting `main`
|
|
163
|
+
- Builds package distributions after tests pass
|
|
164
|
+
- Publishes to PyPI only when you push a version tag like `v0.1.1`
|
|
165
|
+
|
|
166
|
+
#### One-time setup for automatic PyPI publishing
|
|
167
|
+
|
|
168
|
+
1. Create a PyPI account at https://pypi.org and create your project once (or publish once manually so the name exists).
|
|
169
|
+
2. In PyPI, open your project settings and add a **Trusted Publisher**:
|
|
170
|
+
- Owner: your GitHub username/org
|
|
171
|
+
- Repository: `Desperadus/CaveFiller`
|
|
172
|
+
- Workflow name: `CI/CD`
|
|
173
|
+
- Environment: leave empty (unless you choose to use one)
|
|
174
|
+
3. In GitHub, ensure Actions are enabled for the repository.
|
|
175
|
+
|
|
176
|
+
No PyPI API token secret is needed when using Trusted Publishing.
|
|
177
|
+
|
|
178
|
+
#### Releasing a new version
|
|
179
|
+
|
|
180
|
+
1. Bump version in both:
|
|
181
|
+
- `pyproject.toml` (`project.version`)
|
|
182
|
+
- `cavefiller/__init__.py` (`__version__`)
|
|
183
|
+
2. Commit and push to `main`.
|
|
184
|
+
3. Create and push a matching tag:
|
|
185
|
+
|
|
186
|
+
```bash
|
|
187
|
+
git tag v0.1.1
|
|
188
|
+
git push origin v0.1.1
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
The workflow validates that the tag matches `pyproject.toml` (for example, tag `v0.1.1` must match version `0.1.1`) before publishing.
|
|
192
|
+
|
|
193
|
+
## License
|
|
194
|
+
|
|
195
|
+
See LICENSE file for details.
|
|
196
|
+
|
|
197
|
+
## Citation
|
|
198
|
+
|
|
199
|
+
If you use CaveFiller in your research, please cite:
|
|
200
|
+
|
|
201
|
+
- pyKVFinder: Guerra et al. (2020) BMC Bioinformatics
|
|
202
|
+
- RDKit: RDKit: Open-source cheminformatics; http://www.rdkit.org
|
|
203
|
+
|
|
204
|
+
## Contributing
|
|
205
|
+
|
|
206
|
+
Contributions are welcome! Please feel free to submit a Pull Request.
|