Skip to content

Commit

Permalink
docs: update subpackage structure
Browse files Browse the repository at this point in the history
  • Loading branch information
kjappelbaum authored Sep 29, 2023
1 parent 9626b00 commit e9c6f6a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Featurizing a MOF

.. code-block:: python
from mofdscribe.chemistry.racs import RACS
from mofdscribe.featurizers.chemistry.racs import RACS
from pymatgen.core import Structure
s = Structure.from_file(<my_cif>)
Expand All @@ -30,8 +30,8 @@ It is also easy to combine multiple featurizers into a single pipeline:

.. code-block:: python
from mofdscribe.chemistry.racs import RACS
from mofdscribe.pore.geometric_properties import PoreDiameters
from mofdscribe.featurizers.chemistry.racs import RACS
from mofdscribe.featurizers.pore.geometric_properties import PoreDiameters
from pymatgen.core import Structure
from mofdscribe.featurizers.base import MOFMultipleFeaturizer
Expand All @@ -54,7 +54,7 @@ And, clearly, you can also use the `mofdscribe` featurizers alongside ones from
.. code-block:: python
from matminer.featurizers.structure import LocalStructuralOrderParams
from mofdscribe.chemistry.racs import RACS
from mofdscribe.featurizers.chemistry.racs import RACS
featurizer = MOFMultipleFeaturizer([RACS(), LocalStructuralOrderParams()])
features = featurizer.featurize_many([s, s2])
Expand Down

0 comments on commit e9c6f6a

Please sign in to comment.