Skip to content

Commit 2dcdcfd

Browse files
committed
README.md update
1 parent 1987abc commit 2dcdcfd

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The package offers:
2525

2626
* *Fast RMSD evaluation* including symmetry handling, canonicalization, and optimal superposition
2727
* *Structure grouping and pruning* based on distance thresholds or iRMSD criteria
28-
* *Flexible Molecule class* with XYZ/extXYZ parsing and ASE interoperability
28+
* *Flexible Molecule class* with XYZ/extXYZ parsing and ASE/RDKit interoperability
2929
* *Low- and high-level APIs* that expose direct Fortran wrappers as well as convenient Python abstractions
3030
* *Extendable infrastructure* for future shape metrics and ensemble workflows
3131

@@ -402,12 +402,12 @@ options:
402402
Optional output file for sorted / clustered results.
403403
```
404404

405-
For more information refer to the docs.
405+
For more information refer to the docs (pprcht.github.io/irmsd/)[https://pprcht.github.io/irmsd/].
406406

407407
<br>
408408

409409
### Python Script Usage
410-
A list of the provided functions and types can be found in the docs. A simple function could look like this:
410+
A list of the provided functions and types can be found in the docs (pprcht.github.io/irmsd/generated/irmsd.html#module-irmsd)[https://pprcht.github.io/irmsd/generated/irmsd.html#module-irmsd]. A simple function could look like this:
411411
```python
412412
from irmsd import read_structures, sorter_irmsd_molecule
413413

src/irmsd/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ def build_parser() -> argparse.ArgumentParser:
148148
help=(
149149
"Sort, prune or cluster structures based on inter-structure measures."
150150
" By default, the more expensive iRMSD version is used. The use of the"
151-
" molecules' energies is optional (--ethr) is optional but recommended."
151+
" molecules' energies is optional (--ethr) but recommended."
152152
" To fall back to the quicker, but more empirical CREGEN workflow for"
153153
" ensemble sorting (using energies, quaternion RMSDs and rotational"
154154
" constants), use --classic"

0 commit comments

Comments
 (0)