Skip to content

Commit 433d793

Browse files
committed
Update docs.
1 parent 069a25e commit 433d793

File tree

8 files changed

+81
-275
lines changed

8 files changed

+81
-275
lines changed

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ pip install -r requirements.txt
8181

8282
# Usage
8383

84-
Many Jupyter notebooks are available on usage. See [notebooks](/notebooks). We also have a tool and tutorial lecture
84+
Many Jupyter notebooks are available on usage. See [notebooks](https://github.com/materialsvirtuallab/maml/tree/master/notebooks). We also have a tool and tutorial lecture
8585
at [nanoHUB](https://nanohub.org/resources/maml).
8686

8787
# API documentation

docs/maml.apps.bowsr.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -264,15 +264,15 @@ Bases: `object`
264264

265265
Perturbation class for determining the standard lattice.
266266

267-
#### *property* abc( *: list[float* )
267+
#### *property* abc( *: list[float* )
268268

269269
Returns the lattice lengths.
270270

271-
#### *property* fit_lattice( *: boo* )
271+
#### *property* fit_lattice( *: boo* )
272272

273273
Returns whether the lattice fits any crystal system.
274274

275-
#### *property* lattice( *: Lattic* )
275+
#### *property* lattice( *: Lattic* )
276276

277277
Returns the lattice.
278278

@@ -449,7 +449,7 @@ Holds the perturbations of coordinates/lattice (x_wyckoff/x_lattice)
449449
– formation energy (Y). Allows for constant-time appends while
450450
ensuring no duplicates are added.
451451

452-
#### *property* bounds( *: ndarra* )
452+
#### *property* bounds( *: ndarra* )
453453

454454
Returns the search space of parameters.
455455

@@ -460,7 +460,7 @@ Latin hypercube sampling.
460460
* **Parameters**
461461
**n_intervals** (*int*) – Number of intervals.
462462

463-
#### *property* params( *: ndarra* )
463+
#### *property* params( *: ndarra* )
464464

465465
Returns the parameters in target space.
466466

@@ -489,7 +489,7 @@ lattice perturbation/volume perturbation.
489489

490490
Empty the param, target of the space.
491491

492-
#### *property* target( *: ndarra* )
492+
#### *property* target( *: ndarra* )
493493

494494
Returns the target (i.e., formation energy) in target space.
495495

docs/maml.apps.gbe.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Dict representation of the GBond class.
4646
* **Return type**
4747
dict of {“loc_algo”
4848

49-
#### *property* bond_matrix( *: ndarra* )
49+
#### *property* bond_matrix( *: ndarra* )
5050

5151
The (padded) bond matrix.
5252

@@ -86,11 +86,11 @@ Function to calculate the mean bond length difference between GB and the bulk
8686

8787
Returns: the mean_bl_chg
8888

89-
#### *property* max_bl( *: floa* )
89+
#### *property* max_bl( *: floa* )
9090

9191
The maximum bond length.
9292

93-
#### *property* min_bl( *: floa* )
93+
#### *property* min_bl( *: floa* )
9494

9595
The minimum bond length.
9696

@@ -128,7 +128,6 @@ Describe gb with selected structural and elemental features
128128
:param inc_bulk_ref: whether to generate bulk reference
129129

130130
> bulk reference: i.e. the entry of the origin bulk of the GB,
131-
132131
> ```none
133132
> the rotation angle (theta) = 0, gb_energy = 0
134133
> ```

0 commit comments

Comments
 (0)