Skip to content

Commit 3c2fd43

Browse files
authored
Merge pull request #3 from Buddha7771/docs/readme
docs(readme): fix typos and improve code formatting
2 parents 3af2294 + ec8cd8d commit 3c2fd43

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If you're looking for the models themselves (e.g., RF3, MPNN) that integrate wit
1313
AtomWorks is composed of two symbiotic libraries:
1414

1515
- **atomworks.io:** A universal Python toolkit for parsing, cleaning, manipulating, and converting biological data (structures, sequences, small molecules). Built on the [biotite](https://www.biotite-python.org/) API, it seamlessly loads and exports between standard formats like mmCIF, PDB, FASTA, SMILES, MOL, and more.
16-
- **atomworks.ml:** Advanced dataset featurization and sampling for deep learning workflows that uses `atomworks.io` as its structural backbone. We provide a comprensive, pre-built and well-tested set of `Transforms` for common tasks that can be easily composed into full deep-learning pipelines; users may also create their own `Transforms` for custom operations.
16+
- **atomworks.ml:** Advanced dataset featurization and sampling for deep learning workflows that uses `atomworks.io` as its structural backbone. We provide a comprehensive, pre-built and well-tested set of `Transforms` for common tasks that can be easily composed into full deep-learning pipelines; users may also create their own `Transforms` for custom operations.
1717

1818
For more detail on the motivation for and applications of AtomWorks, please see the [preprint](https://doi.org/10.1101/2025.08.14.670328).
1919

@@ -44,13 +44,13 @@ We have found `atomworks.io` to be useful to a general bioinformatics and protei
4444
- Scripts to pre-process the PDB or other databases into dataframes appropriate for network training
4545
- Efficient sampling and batching utilities for training machine learning models
4646

47-
Within the AtomWorks paradigm, the output of each `Transofrm` is not an opaque dictionary with model-specific tensors but instead an updated version of our atom-level structural representation (Biotite's `AtomArray`). Operations within – and between – pipelines thus maintain a common vocabulary of inputs and outputs.
47+
Within the AtomWorks paradigm, the output of each `Transform` is not an opaque dictionary with model-specific tensors but instead an updated version of our atom-level structural representation (Biotite's `AtomArray`). Operations within – and between – pipelines thus maintain a common vocabulary of inputs and outputs.
4848

4949
---
5050

5151
## Installation
5252

53-
```
53+
```shell
5454
pip install atomworks # base installation version without torch (for only atomworks.io)
5555
pip install "atomworks[ml]" # with torch and ML dependencies (for atomworks.io plus atomworks.ml)
5656
pip install "atomworks[dev]" # with development dependencies
@@ -59,8 +59,8 @@ pip install "atomworks[ml,dev]" # with all dependencies
5959

6060
If you are using [uv](https://docs.astral.sh/uv/reference/policies/versioning/) for package management, you can install atomworks with:
6161

62-
```
63-
uv pip install "atomworks[ml,openbabel,dev]"
62+
```shell
63+
uv pip install "atomworks[ml,openbabel,dev]"
6464
```
6565

6666
For more advanced setup options (including how to run workflows via apptainers) see the [full documentation](https://baker-laboratory.github.io/atomworks-dev/latest).
@@ -69,7 +69,7 @@ For more advanced setup options (including how to run workflows via apptainers)
6969

7070
## Quick Start
7171

72-
```
72+
```python
7373

7474
from atomworks.io.parser import parse
7575

0 commit comments

Comments
 (0)