Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@nnn911
nnn911 committed Nov 19, 2024
1 parent c203652 commit d5fe742
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ The modifier can be found under the label "Denoise particle positions" in the OV

## Parameters

| GUI label | Python name | Description | Default |
|----------------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --------|
| **Number of denoising steps** | `steps` | Number of denoising iterations taken. More iterations require more time. You can check the mean displacement per iteration graph to assess convergence. | `8` |
| **Nearest neighbor distance** | `scale` | Estimation of the nearest neighbor distance used to scale the coordinates before they are input into the model. If this is `None`, OVITO will try to estimate the correct nearest neighbor distance. | `None` |
| **Crystal structure / material system** | `structure` | Allows you to select one of: "FCC", "BCC", "HCP", or "SiO2", depending on your input structure. Note that an SiO2 structure requires a type named "Si" and "O". If you don't want to use any of the default material systems, you can select "Custom". In that case, OVITO will not estimate the "Nearest neighbor distance" and it has to be provided by the user. | `None` |
| **Model file path** | `model_path` | Allows you to define a custom PyTorch model. The model will be loaded from the path entered. If this is set to `None`, the default models for "SiO2" or "Cu" shipped with [graphite](https://github.com/LLNL/graphite/) will be loaded. | `None` |
| **Device** | `device` | Allows you to select your computing device from: "cpu", "cuda", "mps". Only available devices will be shown. Please read the "Installation" section for additional information. | `cpu` |
| **Only selected** | `only_selected` | Apply the modifier only to the selected particles. Following the convention set by other modifiers, even atoms that are not selected will be used as neighbors. | `False` |
| GUI name | Python name | Description | Default |
|-----------------------------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
| **Number of denoising steps** | `steps` | Number of denoising iterations taken. More iterations require more time. You can check the mean displacement per iteration graph to assess convergence. | `8` |
| **Nearest neighbor distance** | `scale` | Estimation of the nearest neighbor distance used to scale the coordinates before they are input into the model. If this is `None`, OVITO will try to estimate the correct nearest neighbor distance. | `None` |
| **Crystal structure / material system** | `structure` | Allows you to select one of: "FCC", "BCC", "HCP", or "SiO2", depending on your input structure. Note that an SiO2 structure requires a type named "Si" and "O". If you don't want to use any of the default material systems, you can select "Custom". In that case, OVITO will not estimate the "Nearest neighbor distance" and it has to be provided by the user. | `None` |
| **Model file path** | `model_path` | Allows you to define a custom PyTorch model. The model will be loaded from the path entered. If this is set to `None`, the default models for "SiO2" or "Cu" shipped with [graphite](https://github.com/LLNL/graphite/) will be loaded. | `None` |
| **Device** | `device` | Allows you to select your computing device from: "cpu", "cuda", "mps". Only available devices will be shown. Please read the "Installation" section for additional information. | `cpu` |
| **Only selected** | `only_selected` | Apply the modifier only to the selected particles. Following the convention set by other modifiers, even atoms that are not selected will be used as neighbors. | `False` |

## Example

Expand Down

0 comments on commit d5fe742

Please sign in to comment.