Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
eahenle committed Jun 26, 2024
1 parent c8100f4 commit d52377d
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/src/molecule.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@ end

## Loading Molecule Files

Molecule input files are stored in `PorousMaterials.PATH_TO_MOLECULES`. Each molecule possesses its own directory containing two files: `charges.csv` and `atoms.csv`, comma-separated-value files, which describe the point charges and Lennard Jones spheres, respectively, that compose the molecule. Only rigid molecules are currently supported. Units of length are in Angstroms ($\AA$); units of charges are electrons.
Molecule input files are stored in the path indicated by the `Xtals`/`PorousMaterials` global dictionary `rc`.

```julia
rc[:paths][:molecules] # absolute or relative path
```

Each molecule possesses its own directory containing two files: `charges.csv` and `atoms.csv`, comma-separated-value files, which describe the point charges and Lennard Jones spheres, respectively, that compose the molecule. Only rigid molecules are currently supported. Units of length are in Angstroms ($\AA$); units of charges are electrons.

```jldoctest molecule
molecule = Molecule("CO2")
Expand Down

0 comments on commit d52377d

Please sign in to comment.