diff --git a/docs/submission-guides/submission/editor.md b/docs/submission-guides/submission/editor.md index c0b6f16..002363e 100644 --- a/docs/submission-guides/submission/editor.md +++ b/docs/submission-guides/submission/editor.md @@ -3,4 +3,118 @@ sidebar_position: 3 title: Structure Editor --- -Coming soon. \ No newline at end of file +# Structure Editor +**[nmrXiv](https://nmrxiv.org)** uses [OpenChemLib](https://github.com/Actelion/openchemlib) as its structure editor, which is presented to the user during the [submission](/docs/submission-guides/submission/upload.md) and, after submission, on the [study](/docs/submission-guides/data-model/study.md) level. Its purpose is to allow the user to provide the structures already known to them before running the NMR spectroscopy analysis. The editor allows drawing up structures from scratch, and it also accepts structures loaded from [SMILES](https://www.daylight.com/dayhtml/doc/theory/theory.smiles.html). Above the editor, there is a link to this documentation that you can always access by clicking `Need help?`. + +Here we provide an overview of the tools available in the editor: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Tool imageUsageTool imageUsage
Clean canvas: it deletes everything resulting in an empty canvas.Undo: it undoes the last change made.
Tidy up canvas: it reorders the molecules and the bonds to provide a better shae of the spaces, lengths, angles, and distances.Zoom and Rotate: by clicking anywhere in the space and scrolling up and down, it enables zooming out and in, while scrolling right and left, it rotates clock-wise and counter-clock.
Lasso select: it enables the lasso selection of atoms and bonds to apply bulk actions, such as with the eraser.
Chirality unknown: it enables adding question marks on chiral centers with unknown chirality.Enantiomere: this tool extends to three tools: **Abs**, which indicates that the provided enantiomer is the one intended. **Or** indicates that the intended structure is either this one, or the other enantiomer. **And** indicates that the intended structure is both of this enantiomer and the other one, with equal quantities, which means having a racemic mixture.
Eraser: it deletes atoms and bonds. When applied to atoms, it deletes the adjacent bonds, while when applied to bonds, it only deletes the adjacent atoms having no more bonds. Bulk erasing can be done by selecting a set of atoms and bonds. Please note that erasing a double bond will result in the full deletion and not in reducing the bond to a single one.
When applied in empty space, it draws a bond between two carbon atoms, while when applied on an atom, it draws a bond between that atom and a carbon atom. Additionally, it can link two already existing atoms. It can also increase the bond level (e.g., single bond to double bond).Chain: it enables drawing saturated aliphatic chains.
Wedge bond: it indicates that the chiral bond is above the ring.Hatched bond: it indicates that the chiral bond is below the ring.
Triangle: it enables drawing a triangle of carbons.Square: it enables drawing a square of carbons.
Pentagon: it enables drawing a pentagon of carbons.Hexagon: it enables drawing a hexagon of carbons.
Heptagon: it enables drawing a heptagon of carbons.Benzene: it enables drawing a Benzene molecules.
Charge plus: it increases the positive charge of atoms.Charge minus: it decreases the positive charge of atoms (increases the negative one).
Carbon atom: it creates a carbon atom, along with hydrogen atoms bonded to it, to reach the carbon's four bonds. So if clicked in space, it creates a Methane molecule. It can also replace an existing atom with a carbon one.Silicon atom: it creates a silicon atom, along with hydrogen atoms bonded to it to reach the silicon's four bonds. So if clicked in space, it creates a Silane molecule. It can also replace an existing atom with a silicon one.
Nitrogen atom: it creates a nitrogen atom, along with hydrogen atoms bonded to it to reach the nitrogen's three bonds. So if clicked in space, it creates an Ammonia molecule. It can also replace an existing atom with a nitrogen one.Phosphorus atom: it creates a phosphorus atom, along with hydrogen atoms bonded to it to reach the phosphorus' three bonds. So if clicked in space, it creates a Phosphine molecule. It can also replace an existing atom with a phosphorus one.
Oxygen atom: it creates an oxygen atom, along with hydrogen atoms bonded to it to reach the oxygen's two bonds. So if clicked in space, it creates a water molecule. It can also replace an existing atom with an oxygen one.Sulfur atom: it creates a sulfur atom along with hydrogen atoms bonded to it to reach the sulfur's two bonds. So if clicked in space, it creates a Hydrogen sulfide molecule. It can also replace an existing atom with a sulfur one.
Fluorine atom: it creates a fluorine atom, along with a hydrogen atom bonded to it, to reach the fluorine's one bond. So if clicked in space, it creates a hydrogen fluoride molecule. It can also replace an existing atom with a fluorine one.Chlorine atom: it creates a chlorine atom, along with a hydrogen atom bonded to it, to reach the chlorine's one bond. So if clicked in space, it creates a hydrogen chloride molecule. It can also replace an existing atom with a chlorine one.
Bromine atom: it creates a bromine atom, along with a hydrogen atom bonded to it to reach the bromine's one bond. So if clicked in space, it creates a hydrogen bromide molecule. It can also replace an existing atom with a bromine one.Iodine atom: it creates an iodine atom, along with a hydrogen atom bonded to it, to reach the iodine one bond. So if clicked in space, it creates a hydrogen iodide molecule. It can als replace an existing atom with an iodine one.
Hydrogen atom: it creates a hydrogen atom, along with a hydrogen atom bonded to it, to reach the hydrogen's one bond. So if clicked in space, it creates a hydrogen molecule. It can also replace an existing atom with a hydrogen one.Atom properties: when applied to an atom, it displays its properties, including the label, mass, valence, and radical state, where the user can edit all of these values.
diff --git a/static/img/editor/abs.png b/static/img/editor/abs.png new file mode 100644 index 0000000..f90d812 Binary files /dev/null and b/static/img/editor/abs.png differ diff --git a/static/img/editor/benzene.png b/static/img/editor/benzene.png new file mode 100644 index 0000000..1ce70d0 Binary files /dev/null and b/static/img/editor/benzene.png differ diff --git a/static/img/editor/bond.png b/static/img/editor/bond.png new file mode 100644 index 0000000..bd53581 Binary files /dev/null and b/static/img/editor/bond.png differ diff --git a/static/img/editor/br.png b/static/img/editor/br.png new file mode 100644 index 0000000..ae5dac5 Binary files /dev/null and b/static/img/editor/br.png differ diff --git a/static/img/editor/c.png b/static/img/editor/c.png new file mode 100644 index 0000000..cab3d50 Binary files /dev/null and b/static/img/editor/c.png differ diff --git a/static/img/editor/chain.png b/static/img/editor/chain.png new file mode 100644 index 0000000..bab3d04 Binary files /dev/null and b/static/img/editor/chain.png differ diff --git a/static/img/editor/cl.png b/static/img/editor/cl.png new file mode 100644 index 0000000..20a43f1 Binary files /dev/null and b/static/img/editor/cl.png differ diff --git a/static/img/editor/eraser.png b/static/img/editor/eraser.png new file mode 100644 index 0000000..2e59026 Binary files /dev/null and b/static/img/editor/eraser.png differ diff --git a/static/img/editor/f.png b/static/img/editor/f.png new file mode 100644 index 0000000..f060189 Binary files /dev/null and b/static/img/editor/f.png differ diff --git a/static/img/editor/h.png b/static/img/editor/h.png new file mode 100644 index 0000000..22be08a Binary files /dev/null and b/static/img/editor/h.png differ diff --git a/static/img/editor/hatch.png b/static/img/editor/hatch.png new file mode 100644 index 0000000..2b9cbc9 Binary files /dev/null and b/static/img/editor/hatch.png differ diff --git a/static/img/editor/heptagon.png b/static/img/editor/heptagon.png new file mode 100644 index 0000000..1e0d160 Binary files /dev/null and b/static/img/editor/heptagon.png differ diff --git a/static/img/editor/hexagon.png b/static/img/editor/hexagon.png new file mode 100644 index 0000000..9465e82 Binary files /dev/null and b/static/img/editor/hexagon.png differ diff --git a/static/img/editor/i.png b/static/img/editor/i.png new file mode 100644 index 0000000..12a7438 Binary files /dev/null and b/static/img/editor/i.png differ diff --git a/static/img/editor/laso.png b/static/img/editor/laso.png new file mode 100644 index 0000000..05c52ee Binary files /dev/null and b/static/img/editor/laso.png differ diff --git a/static/img/editor/minus.png b/static/img/editor/minus.png new file mode 100644 index 0000000..b62e668 Binary files /dev/null and b/static/img/editor/minus.png differ diff --git a/static/img/editor/n.png b/static/img/editor/n.png new file mode 100644 index 0000000..31c54d9 Binary files /dev/null and b/static/img/editor/n.png differ diff --git a/static/img/editor/o.png b/static/img/editor/o.png new file mode 100644 index 0000000..f39db1f Binary files /dev/null and b/static/img/editor/o.png differ diff --git a/static/img/editor/p.png b/static/img/editor/p.png new file mode 100644 index 0000000..ff3f9b1 Binary files /dev/null and b/static/img/editor/p.png differ diff --git a/static/img/editor/pentagon.png b/static/img/editor/pentagon.png new file mode 100644 index 0000000..4741289 Binary files /dev/null and b/static/img/editor/pentagon.png differ diff --git a/static/img/editor/plus.png b/static/img/editor/plus.png new file mode 100644 index 0000000..50bd01f Binary files /dev/null and b/static/img/editor/plus.png differ diff --git a/static/img/editor/q.png b/static/img/editor/q.png new file mode 100644 index 0000000..823f638 Binary files /dev/null and b/static/img/editor/q.png differ diff --git a/static/img/editor/question.png b/static/img/editor/question.png new file mode 100644 index 0000000..f62d821 Binary files /dev/null and b/static/img/editor/question.png differ diff --git a/static/img/editor/rotate.png b/static/img/editor/rotate.png new file mode 100644 index 0000000..0e15c16 Binary files /dev/null and b/static/img/editor/rotate.png differ diff --git a/static/img/editor/s.png b/static/img/editor/s.png new file mode 100644 index 0000000..89f9dee Binary files /dev/null and b/static/img/editor/s.png differ diff --git a/static/img/editor/si.png b/static/img/editor/si.png new file mode 100644 index 0000000..37203ba Binary files /dev/null and b/static/img/editor/si.png differ diff --git a/static/img/editor/square.png b/static/img/editor/square.png new file mode 100644 index 0000000..977c647 Binary files /dev/null and b/static/img/editor/square.png differ diff --git a/static/img/editor/star.png b/static/img/editor/star.png new file mode 100644 index 0000000..8466281 Binary files /dev/null and b/static/img/editor/star.png differ diff --git a/static/img/editor/text.png b/static/img/editor/text.png new file mode 100644 index 0000000..4fc91cb Binary files /dev/null and b/static/img/editor/text.png differ diff --git a/static/img/editor/tool.png b/static/img/editor/tool.png new file mode 100644 index 0000000..39335d1 Binary files /dev/null and b/static/img/editor/tool.png differ diff --git a/static/img/editor/trash.png b/static/img/editor/trash.png new file mode 100644 index 0000000..3ba24a4 Binary files /dev/null and b/static/img/editor/trash.png differ diff --git a/static/img/editor/triangle.png b/static/img/editor/triangle.png new file mode 100644 index 0000000..17ed650 Binary files /dev/null and b/static/img/editor/triangle.png differ diff --git a/static/img/editor/undo.png b/static/img/editor/undo.png new file mode 100644 index 0000000..ac49b08 Binary files /dev/null and b/static/img/editor/undo.png differ diff --git a/static/img/editor/wedge.png b/static/img/editor/wedge.png new file mode 100644 index 0000000..fbec369 Binary files /dev/null and b/static/img/editor/wedge.png differ