Skip to content

Commit fdb85a2

Browse files
committed
Docs: tutorial update
- Removed 'tools' from the index for the tutorial - Updated list of parser arguments to match what is in `src/atomworks/io/parser.py` (in the production branch) - Changed example function in trasnformst.rst to one that exists.
1 parent 8c1b82c commit fdb85a2

3 files changed

Lines changed: 23 additions & 16 deletions

File tree

docs/tutorial/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,5 @@ Quick Install:
2121
:caption: Main Concepts
2222

2323
parser
24-
tools
2524
transforms
2625
utils

docs/tutorial/parser.rst

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ Example Usage
1212
result = parse(filename="/databases/rcsb/cif/ne/3nez.cif.gz")
1313
print(result["chain_info"])
1414
15-
Returned Dictionary
16-
-------------------
15+
What's in the Dictionary Returned by the Parser?
16+
------------------------------------------------
1717
- **chain_info**: Mapping of chain IDs to sequence, type, and metadata
18-
- **ligand_info**: Information about ligands in the structure
19-
- **asym_unit**: AtomArrayStack of the asymmetric unit
18+
- **ligand_info**: Information about ligands in the structure, if there are any
19+
- **asym_unit**: AtomArrayStack of the asymmetric unit, contains similar information to what is contained in a PDB file
2020
- **assemblies**: Mapping of assembly IDs to AtomArrayStacks
21-
- **metadata**: Structure-level metadata
21+
- **metadata**: Structure-level metadata, such as crystallization details, the method used to determine the structure, resolution, etc.
2222
- **extra_info**: Internal-use information for caching and compatibility
2323

2424
Parsing Arguments
@@ -67,18 +67,18 @@ Parsing Arguments
6767
- bool
6868
- True
6969
- Fix formal charges on atoms involved in inter-residue bonds.
70+
* - fix_bond_types
71+
- bool
72+
- True
73+
- Whether to correct for nucleophilic additions on atoms involved in inter-residue bonds.
7074
* - convert_mse_to_met
7175
- bool
7276
- False
7377
- Convert selenomethionine (MSE) to methionine (MET).
74-
* - remove_hydrogens
75-
- bool or None
76-
- None
77-
- Remove hydrogens from structure. Deprecated; use hydrogen_policy instead.
7878
* - hydrogen_policy
79-
- "keep" / "remove" / "infer"
80-
- "keep"
81-
- Whether to keep, remove, or infer hydrogens.
79+
- "keep" / "remove" / "infer"
80+
- "keep"
81+
- Whether to keep, remove, or infer hydrogens.
8282
* - model
8383
- int or None
8484
- None
@@ -92,7 +92,7 @@ Parsing Arguments
9292
- None
9393
- Extra fields to include in the AtomArrayStack.
9494

95-
Caching Arguments
95+
Wrapper Arguments
9696
-----------------
9797

9898
.. list-table::
@@ -102,6 +102,14 @@ Caching Arguments
102102
- Type
103103
- Default
104104
- Description
105+
* - file_type
106+
- "cif" / "pdb" / "mmjson" / None
107+
- None
108+
- File type to parse. If None, inferred from filename extension.
109+
* - ccd_mirror_path
110+
- PathLike / None
111+
- None
112+
- Path to local mirror of the Chemical Component Dictionary. (Recommended)
105113
* - load_from_cache
106114
- bool
107115
- False

docs/tutorial/transforms.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ Example Usage
77
-------------
88
.. code-block:: python
99
10-
from atomworks.io.transforms.atom_array import rotate_structure
11-
rotated = rotate_structure(atom_array, angle=90, axis="z")
10+
from atomworks.io.transforms.atom_array import remove_ccd_components
11+
cleaned = remove_ccd_components(atom_array)

0 commit comments

Comments
 (0)