Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maabuu committed Aug 11, 2023
1 parent 7928f46 commit b5f4c2c
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# <img src="docs/source/_static/logo_banner.png" alt="drawing" height="75"/>

PoseBusters: Command line tool and Python package for checking the chemical
and physical sensibility of docked or generated molecules.
and physical sensibility of docked or generated molecule poses.


## Installation
Expand All @@ -19,20 +19,21 @@ conda install posebusters -c conda-forge -->
### Command line

```bash
# check re-docked ligand (new ligand into protein).
bust redock ligand_pred.sdf mol_true.sdf mol_cond.pdb
# Check docked ligand (new ligand for a given protein).
bust ligand_pred.sdf -p mol_cond.pdb

# check docked ligand (where crystal protein-ligand structure is known).
bust dock ligand_pred.sdf protein.pdb
# Check re-docked ligand (where crystal protein-ligand structure is known).
bust ligand_pred.sdf -l mol_true.sdf -p protein.pdb

# check generated molecule (only check ligand).
bust mol molecule_pred.sdf
# Check generated molecule pose. Also supports wildcard.
bust molecule_pred.sdf
bust *_pred.sdf

# check multiple of the three above using a .csv input:
bust table file_table.csv
# Check any of the three by providing a csv with files to check together
bust -t file_table.csv
```

### Python API
<!-- ### Python API
```python
from dockbusters import DockBuster
Expand All @@ -45,7 +46,7 @@ DockBuster().bust_dock(ligand_pred_file, protein_crystal_file)
# check molecule
DockBuster().bust_mol(ligand_pred_file, protein_crystal_file)
```
``` -->

## Thanks

Expand Down

0 comments on commit b5f4c2c

Please sign in to comment.