Skip to content

Commit

Permalink
Grammatical, spelling and other comments for the Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
saswatnayak1998 authored and rosecers committed Nov 13, 2023
1 parent 4576050 commit 2634850
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/src/embedding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Chemiscope as a library
=======================

It is possible to use chemiscope as a software library when writing your own
web-based interface. This page document how to get the library and give a few
web-based interface. This page documents how to get the library and provides a few
usage examples.

.. note::
Expand Down Expand Up @@ -95,7 +95,7 @@ And import the library inside your own code using
const Chemiscope = require("chemiscope");
If your are using TypeScript, definition files are also provided with the npm
If you are using TypeScript, definition files are also provided with the npm
package, and should give you auto-completion, inline documentation and interface
checking.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/manual/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ User manual
This manual presents an overview of how to interact with the chemiscope viewer
in its "standard" implementation - including the web tool and the jupyter widget.
It does not discuss in detail how to build a low-dimensional representation of
a chemical dataset - chemiscope is just a viewer, and there are many tools available
a chemical dataset - chemiscope is solely a viewer, and there are many tools available
to perform this kind of analyses.

This section starts introducing the concept of structural and physical properties,
Expand Down
2 changes: 1 addition & 1 deletion docs/src/manual/input.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Creating chemiscope input files
===============================

When using the default chemiscope interface, all the structures and properties
in a dataset are loaded from a single JSON file. This sections describe how to
in a dataset are loaded from a single JSON file. These sections describe how to
generate such JSON file, either using a pre-existing python script that does
most of the work for you, or by writing the JSON file directly. Since the
resulting JSON file can be quite large and thus harder to share with
Expand Down
2 changes: 1 addition & 1 deletion docs/src/manual/jupyter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Jupyter notebooks

Chemiscope can be used as a widget in Jupyter notebooks, that should work in both Jupyter classic and JupyterLab.
The widget can be created in `default` mode (showing both a structure and a map panel), or used to display only
structures or only proeprties.
structures or only properties.

Once created, it is possible to interact with the widget using a traitlet interface, modeled after
`Jupyter widgets <http://ipywidgets.readthedocs.io>`_.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/manual/panels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ display.

The map is a 2D or 3D scatter plot showing properties for all the environments
in the dataset. You can set which properties (structural or physical) should be
used a the x, y, and potentially z axis; as well as for color and size of the
points. Additionally, properties which have string values (an not numeric
used as the x, y, and potentially z axis; as well as for color and size of the
points. Additionally, properties which have string values (and not numeric
values) can be used as category data to set the symbols used for the points. To
open the settings modal window, click on the hamburger menu (the ☰ symbol) on
the left of the dataset title.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/manual/properties.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ properties.
Chemiscope can work with two kinds of entities: full structures, or
atom-centred environments. A structure consists in a set of atoms, possibly
representing the periodic repeat unit of an infinite structure. An
environment consists in a set of atoms that surround a central atom,
environment consists in a set of atoms that surround a central atom.
In both cases, these entities are fully defined by the position and nature
of the atoms present in the structure, or in the neighborhood of the
environment center.
Expand All @@ -26,7 +26,7 @@ as possible, yet concise. Examples of such representations are for instance
symmetry functions <Behler-Parrinello>`_. These representations are usually
high-dimensional vectors, hard to visualize and interpret. For this reason, one
usually applies a dimensionality reduction algorithm, such as `PCA`_, `sketch-map`_,
`PCovR`_, *etc.* The interpretation of the resulting will differ depending on
`PCovR`_, *etc.* The interpretation of the resulting descriptor will differ depending on
both the descriptor used to represent the structures or environments and the
dimensionality reduction algorithm applied.

Expand Down

0 comments on commit 2634850

Please sign in to comment.