Skip to content

Commit

Permalink
Merge pull request #46 from Avogadro/fixup-build
Browse files Browse the repository at this point in the history
Added images and tweaked user docs
  • Loading branch information
ghutchis authored Oct 29, 2023
2 parents 2c93200 + 396c024 commit 60154bb
Show file tree
Hide file tree
Showing 343 changed files with 312 additions and 294 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/1-sort-by.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/2-unit-of-measure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/6vxx-yes.png
Binary file added source/_images/Caffeine.png
Binary file added source/_images/CloseContact.png
Binary file added source/_images/Covid Spike.png
Binary file added source/_images/CuPc.png
Binary file added source/_images/DNA-hbonds.png
Binary file added source/_images/Download.png
Binary file added source/_images/EEM Charges.png
Binary file added source/_images/Picture-1.png
Binary file added source/_images/Picture-2-1.png
Binary file added source/_images/Plugin Downloader.png
Binary file added source/_images/Symmetry.png
Binary file added source/_images/add-hydrogens-for-ph.png
Binary file added source/_images/add-hydrogens.png
Binary file added source/_images/align-view-to-axes.png
Binary file added source/_images/all-molecules-in-file.png
Binary file added source/_images/animation.png
Binary file added source/_images/axes.png
Binary file added source/_images/ball-and-stick.png
Binary file added source/_images/calculate-energy.png
Binary file added source/_images/cartesian-editor.png
Binary file added source/_images/cartoon.png
Binary file added source/_images/centers.png
Binary file added source/_images/change-h-to-methyl.png
Binary file added source/_images/change-the-force-field-options.png
Binary file added source/_images/changing-surface-settings.png
Binary file added source/_images/close-view.png
Binary file added source/_images/configure.png
Binary file added source/_images/conformer-search.png
Binary file added source/_images/constraints.png
Binary file added source/_images/copy-as.png
Binary file added source/_images/create-surfaces.png
Binary file added source/_images/creating-a-molecule.png
Binary file added source/_images/creating-a-surface-.png
Binary file added source/_images/crystal-view-options.png
Binary file added source/_images/debug-information.png
Binary file added source/_images/detach-view.png
Binary file added source/_images/dipole.png
Binary file added source/_images/display-axes.png
Binary file added source/_images/duplicate-view.png
Binary file added source/_images/example-cont.png
Binary file added source/_images/example.png
Binary file added source/_images/export.png
Binary file added source/_images/force.png
Binary file added source/_images/hemoglobin.png
Binary file added source/_images/hydrogen-bond.png
Binary file added source/_images/import.png
Binary file added source/_images/importing-directly.png
Binary file added source/_images/insert.png
Binary file added source/_images/invert-chirality.png
Binary file added source/_images/invert-selection.png
Binary file added source/_images/label.png
Binary file added source/_images/ligands.png
Binary file added source/_images/locating-display-types.png
Binary file added source/_images/media_1244841742875.png
Binary file added source/_images/media_1244842311139.png
Binary file added source/_images/media_1244842940490.png
Binary file added source/_images/media_1244842953032.png
Binary file added source/_images/media_1244843543134.png
Binary file added source/_images/media_1244843607484.png
Binary file added source/_images/media_1260118979959.png
Binary file added source/_images/media_1260119377141.png
Binary file added source/_images/media_1260119456591.png
Binary file added source/_images/media_1260119601872.png
Binary file added source/_images/media_1260119685502.png
Binary file added source/_images/media_1260119852731.png
Binary file added source/_images/media_1260120107101.png
Binary file added source/_images/media_1260120454671.png
Binary file added source/_images/media_1260120552391.png
Binary file added source/_images/media_1260120773167.png
Binary file added source/_images/media_1332447195630.png
Binary file added source/_images/media_1332447360825.png
Binary file added source/_images/media_1332448938642.png
Binary file added source/_images/media_1332468285179.png
Binary file added source/_images/media_1332469166966.png
Binary file added source/_images/media_1332469324737.png
Binary file added source/_images/media_1332469442064.png
Binary file added source/_images/media_1332469725677.png
Binary file added source/_images/media_1332469784810.png
Binary file added source/_images/media_1332469837440.png
Binary file added source/_images/media_1332470049992.png
Binary file added source/_images/media_1332470085470.png
Binary file added source/_images/media_1332470208253.png
Binary file added source/_images/media_1340250901000.png
Binary file added source/_images/media_1340250954094.png
Binary file added source/_images/media_1340251076292.png
Binary file added source/_images/media_1340251126011.png
Binary file added source/_images/media_1340251283231.png
Binary file added source/_images/media_1340251460215.png
Binary file added source/_images/media_1340251491638.png
Binary file added source/_images/media_1340251768869.png
Binary file added source/_images/media_1340329424336.png
Binary file added source/_images/media_1340329441585.png
Binary file added source/_images/media_1340331425028.png
Binary file added source/_images/media_1340331450497.png
Binary file added source/_images/media_1340331470946.png
Binary file added source/_images/media_1340331503702.png
Binary file added source/_images/media_1340331539150.png
Binary file added source/_images/media_1340331911582.png
Binary file added source/_images/media_1340331923310.png
Binary file added source/_images/media_1340331942795.png
Binary file added source/_images/media_1340331963717.png
Binary file added source/_images/media_1340331979486.png
Binary file added source/_images/media_1340331996253.png
Binary file added source/_images/media_1340332629038.png
Binary file added source/_images/media_1340332954652.png
Binary file added source/_images/media_1340332967365.png
Binary file added source/_images/media_1340332976902.png
Binary file added source/_images/media_1340332995909.png
Binary file added source/_images/media_1340333044109.png
Binary file added source/_images/media_1340334543445.png
Binary file added source/_images/media_1340334581991.png
Binary file added source/_images/media_1340334958508.png
Binary file added source/_images/media_1340335027391.png
Binary file added source/_images/media_1340335238130.png
Binary file added source/_images/media_1340335304968.png
Binary file added source/_images/media_1340335353244.png
Binary file added source/_images/media_1340335406817.png
Binary file added source/_images/media_1340336029160.png
Binary file added source/_images/media_1340336076337.png
Binary file added source/_images/media_1340336318568.png
Binary file added source/_images/media_1340336361329.png
Binary file added source/_images/media_1340336453963.png
Binary file added source/_images/media_1340336917161.png
Binary file added source/_images/media_1340336935090.png
Binary file added source/_images/media_1340337013909.png
Binary file added source/_images/media_1340337222403.png
Binary file added source/_images/media_1340337322190.png
Binary file added source/_images/media_1340337494733.png
Binary file added source/_images/media_1340337575679.png
Binary file added source/_images/media_1387168509505.png
Binary file added source/_images/mmff94-s-.png
Binary file added source/_images/molecular-mechanics.png
Binary file added source/_images/molecular-orbitals.png
Binary file added source/_images/open-a-crystal-file.png
Binary file added source/_images/open-the-lammps-input-dialog.png
Binary file added source/_images/opening-a-file.png
Binary file added source/_images/optimize-the-geometry.png
Binary file added source/_images/polygon.png
Binary file added source/_images/prepare-initial-geometry.png
Binary file added source/_images/prepare-simulation-parameters.png
Binary file added source/_images/properties.png
Binary file added source/_images/remove-hydrogens.png
Binary file added source/_images/reset-display-types.png
Binary file added source/_images/ribbon.png
Binary file added source/_images/ring.png
Binary file added source/_images/run-lammps.png
Binary file added source/_images/running-gaussian.png
Binary file added source/_images/select-all.png
Binary file added source/_images/select-by-element.png
Binary file added source/_images/select-by-residue.png
Binary file added source/_images/select-smarts.png
Binary file added source/_images/set-background-color.png
Binary file added source/_images/setup-force-field.png
Binary file added source/_images/show-spectra.png
Binary file added source/_images/simple-wireframe.png
Binary file added source/_images/spectra.png
Binary file added source/_images/start-with-a-wfn-file.png
Binary file added source/_images/stick.png
Binary file added source/_images/surfaces.png
Binary file added source/_images/van-der-waals-spheres.png
Binary file added source/_images/wireframe.png
26 changes: 25 additions & 1 deletion source/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,30 @@

# Develop

Avogadro libraries can be used from both C++ and Python interfaces.
Avogadro can be extended from both C++ and Python interfaces.

In many cases,

## Script Plugins

Many features in Avogadro can be extended with Python scripts, including:

- menu commands
- electrostatic models
- force fields
- input generators

For more details, see the [script plugin](../scripts/index) documentation.

## External Scripting

Avogadro supports sending messages from external scripts, through
remote procedure call (RPC) JSON. This can be very helpful for rendering
images of molecules, generating orbitals, etc.

For more details, see the [RPC](rpc) documentation.

## Libraries

The Avogadro libraries are developed to support the Avogadro2 application, and
provide liberally BSD-licensed, open-source reusable components for both C++ and Python. At its core it is a platform for developing molecular visualization, editing and interactive simulation applications. This is achieved using a collection of libraries, along with a plugin interface allowing the platform to be easily extended and used in a variety of environments.
Expand Down Expand Up @@ -44,6 +67,7 @@ maxdepth: 2
hidden: true
---
../scripts/index
rpc
classlist
```
3 changes: 2 additions & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
'sphinx.ext.viewcode',
'sphinx_design',
'sphinx_copybutton',
#'breathe',
'breathe',
'myst_parser',
]

Expand All @@ -74,6 +74,7 @@
myst_substitutions = {
"release": release,
"macurl": f"https://github.com/OpenChemistry/avogadrolibs/releases/download/{version}/Avogadro2-{version}-Darwin.dmg",
"macarmurl": f"https://github.com/OpenChemistry/avogadrolibs/releases/download/{version}/Avogadro2-{version}-Darwin-arm64.dmg",
"winurl": f"https://github.com/OpenChemistry/avogadrolibs/releases/download/{version}/Avogadro2-{version}-win64.exe",
"appurl": f"https://github.com/OpenChemistry/avogadrolibs/releases/download/{version}/Avogadro2-x86_64.AppImage"
}
Expand Down
12 changes: 6 additions & 6 deletions source/docs/building-materials/building-a-crystal-slab.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@ Build up a crystal surface, e.g., Pt for a defined Miller Plane.

## Import the appropriate crystal structure.

![](../.gitbook/assets/import-the-appropriate-crystal-structure.png)
![](../../_images/import-the-appropriate-crystal-structure.png)

Either open a CIF file with the crystal structure needed, or import one from the built-in Avogadro crystal library. The tutorial will assume you import a structure from the Avogadro library. Choose File > Import > Crystal to bring up the library.

![](../.gitbook/assets/media_1332447195630.png)
![](../../_images/media_1332447195630.png)

Either browse through the crystals, or type a filter -- by element or name. Click "Insert" to import the selected structure.

![](../.gitbook/assets/media_1332447360825.png)
![](../../_images/media_1332447360825.png)

Importing a crystal will show the asymmetric unit cell \(e.g., one atom for Silver here\).

![](../.gitbook/assets/media_1332448938642.png)
![](../../_images/media_1332448938642.png)

To build a specified surface \(e.g., Ag \) choose Crystallography > Build > Slab... to bring up the slab builder settings. Future crystal builders \(e.g., nanoparticles, supercells\) will also appear in this menu.

![](../.gitbook/assets/3d1781c8-d8ba-45ce-af85-65625a1c4d24.png)
![](../../_images/3d1781c8-d8ba-45ce-af85-65625a1c4d24.png)

Specify the indices of the Miller plane desired \(for hexagonal unit cells, all 4 indices will appear\), and choose the dimensions in either distances or repeating cells of the resulting surface. The generated surface is aligned in the XY plane, and a specified thickness will be cleaved in the z-axis below the XY plane. This feature allows easy alignment between a new surface and a molecule for surface interaction calculations. Click "Build" to start the surface generation.

![](../.gitbook/assets/media_1332468285179.png)
![](../../_images/media_1332468285179.png)

After clicking "Build," Avogadro will generate a large supercell, align, rotate, and cleave the designated surface. This may take some time, depending on the size of the crystal cell. Here translucent van der Waals spheres are used to illustrate the corrugation of the Ag surface. The resulting surface is a 2x2 supercell, with a large spacing \(40 Å\) in the z-axis.

24 changes: 12 additions & 12 deletions source/docs/building-materials/building-a-polymer-unit-cell.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,51 +2,51 @@

A walk-through on creating a unit cell \(of a polymer\) using Avogadro and the Align tool. This specific example uses Gaussian, but translation vectors for other programs can be performed similarly.

![](../.gitbook/assets/media_1260118979959.png)
![](../../_images/media_1260118979959.png)

Build out the molecule for the unit cell. Notice that while the repeat unit here is 2 rings, we have built 3 rings. This way, we will properly model the bond which spans two unit cells.

![](../.gitbook/assets/media_1260119377141.png)
![](../../_images/media_1260119377141.png)

Optimize the geometry of the molecule.

![](../.gitbook/assets/media_1260119456591.png)
![](../../_images/media_1260119456591.png)

Switch to the Align tool to translate and orient the unit cell coordinates.

![](../.gitbook/assets/media_1260119601872.png)
![](../../_images/media_1260119601872.png)

Make sure to open the Tool Settings window, which will allow you to work with the Align tool.

![](../.gitbook/assets/media_1260119685502.png)
![](../../_images/media_1260119685502.png)

First click on the "start" atom of the polythiophene. This atom will be translated to the origin \(0, 0, 0\). Then click on the corresponding atom in the "next" unit cell. The distance between these two atoms will define one axis in the unit cell.

![](../.gitbook/assets/media_1260119852731.png)
![](../../_images/media_1260119852731.png)

In the "Align Settings" window, define an axis for the unit cell. Then click the Align button. This will change the coordinate set to have atom \#1 at the origin, and atom \#2 \(from the step above\) projected onto the x-axis.

![](../.gitbook/assets/media_1260120107101.png)
![](../../_images/media_1260120107101.png)

Open the Cartesian Editor window to verify the results of the Align operation.

![](../.gitbook/assets/Screen-shot-2009-12-06-at-12.23.01-PM.png)
![](../../_images/Screen-shot-2009-12-06-at-12.23.01-PM.png)

Notice that atom \#1 is at the origin, and atom \#11 is projected onto the X-axis. The size of the unit cell is 7.806Å -- the distance between atom \#1 and atom \#11.

![](../.gitbook/assets/media_1260120454671.png)
![](../../_images/media_1260120454671.png)

Now delete "extra" atoms which should not be included in the unit cell calculations. This includes the third ring \(including atom 11\) and the "end" hydrogen atoms. For example, you can use the select tool and drag over the atoms to be deleted to pick them.

![](../.gitbook/assets/media_1260120552391.png)
![](../../_images/media_1260120552391.png)

Once selected, you can use the "Clear" menu command to delete the atoms.

![](../.gitbook/assets/media_1260120773167.png)
![](../../_images/media_1260120773167.png)

If you wish to submit the unit cell to Gaussian, pick the Gaussian input extension.

![](../.gitbook/assets/Screen-shot-2009-12-06-at-12.36.05-PM.png)
![](../../_images/Screen-shot-2009-12-06-at-12.36.05-PM.png)

Set options as you desire. Make sure to add a "TV 7.806 0.0 0.0" line at the bottom of the preview text. This will enable the unit cell calculation by setting the translation vector for the unit cell.

Loading

0 comments on commit 60154bb

Please sign in to comment.