Skip to content

Commit 2438a84

Browse files
doc updates following review
1 parent 6ebcb0a commit 2438a84

File tree

3 files changed

+22
-10
lines changed

3 files changed

+22
-10
lines changed

docs/cookbook/creating_mappings.rst renamed to docs/cookbook/creating_atom_mappings.rst

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
Creating mappings
2-
=================
1+
.. _Creating Atom Mappings:
32

4-
With your chemical models loaded and defined into two :class:`.ChemicalSystem` objects,
5-
we can now proceed to defining how components in these systems correspond.
6-
``Mapping`` objects are used to defined how ``Component`` objects from different systems are related.
3+
Creating Atom Mappings
4+
======================
5+
6+
Once your :ref:`data has been loaded<Loading Molecules>`
7+
we can now proceed to defining how Components in these Systems correspond.
8+
``Mapping`` objects are used to defined how ``Component`` objects from different :class:`ChemicalSystems` are related.
79
This guide will show how this concept applies to the case of a pair of ligands we wish to transform between.
810

911
Generating Mappings
@@ -43,7 +45,7 @@ This is how we can create a mapping between two ligands:
4345
4446
The first and second ligand molecules put into the ``suggest_mappings`` method
4547
are then henceforth referred to as ``componentA`` and ``componentB``.
46-
The correspondence of atoms in these two components is then given via the `.componentA_to_componentB` attribute,
48+
The correspondence of atoms in these two components is then given via the ``.componentA_to_componentB`` attribute,
4749
which returns a dictionary of integers.
4850
Keys in this dictionary refer to the indices of atoms in the "A" molecule,
4951
while the corresponding values refer to indices of atoms in the "B" molecule.

docs/cookbook/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This will include various how-to guides.
66
.. toctree::
77

88
loading_molecules
9-
creating_mappings
9+
creating_atom_mappings
1010
dumping_transformation
1111

1212

docs/cookbook/loading_molecules.rst

+13-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _Loading Molecules:
2+
13
Loading your data into ChemicalSystems
24
======================================
35

@@ -52,14 +54,21 @@ As these types of structures are typically stored inside sdf files, there is a `
5254
smc = openfe.SmallMoleculeComponent.from_sdf_file('file.sdf')
5355
5456
57+
.. note::
58+
The ``from_sdf_file`` method will only read the first molecule in a multi-molecule MolFile.
59+
To load multiple molcules, use RDKit's ``Chem.SDMolSupplier`` to iterate over the contents,
60+
and create a ``SmallMoleculeComponent`` from each.
61+
62+
5563
Loading proteins
5664
----------------
5765

5866
Proteins are handled using an :class:`openfe.ProteinComponent`.
5967
Like ``SmallMoleculeComponent``, these are based upon RDKit Molecules,
6068
however these are expected to have the `MonomerInfo` struct present on all atoms.
6169
This struct contains the residue and chain information and is essential to apply many popular force fields.
62-
A "protein" here is considered as the fully modelled entire biological assembly, i.e. all chains and structural waters.
70+
A "protein" here is considered as the fully modelled entire biological assembly,
71+
i.e. all chains and structural waters and ions etc.
6372

6473
To load a protein, use the :func:`openfe.ProteinComponent.from_pdb_file` or :func:`openfe.ProteinComponent.from_pdbx_file` classmethod
6574

@@ -78,8 +87,9 @@ Unlike the previously detailed Components, this does not have any explicit molec
7887
but instead represents the way that the overall system will be solvated.
7988
This information is then interpreted inside the ``Protocol`` when solvating the system.
8089

81-
By default, this solvent is water. The positive and negative ion can be defined, as well as the ion concentration
82-
which must be specified along with the unit.
90+
By default, this solvent is water with 0.15 M NaCl salt.
91+
All parameters; the positive and negative ion as well as the ion concentration (which must be specified along with the unit)
92+
can be freely defined.
8393

8494
.. code::
8595

0 commit comments

Comments
 (0)