Fix typos in docs

docs/source/getting_started/index.rst

@@ -39,7 +39,7 @@ Quick install
     :card: + install-card
     :column: col-lg-6 col-md-6 col-sm-12 col-xs-12 p-3
 
-    Working with conda?
+    Working with Conda?
     ^^^^^^^^^^^^^^^^^^^
 
     ANDES is available on conda-forge and can be installed with
@@ -69,7 +69,7 @@ Quick install
 
     New to Python?
     ^^^^^^^^^^^^^^
-    Set up a Mambaforge environment following :ref:`Setup Mambaforge`. We
+    Set up a Mambaforge environment by following :ref:`Setup Mambaforge`. We
     recommend Mambaforge on Windows and Apple Silicon for new users.
 
     ---

docs/source/getting_started/install.rst

@@ -27,15 +27,15 @@ Next, complete the Mambaforge installation on your system.
 .. note::
 
     Mambaforge is a drop-in replacement for conda. If you have an existing
-    conda installation, you can replace all following ``mamba`` commands
-    with ``conda`` and achieve the same functionality.
+    conda installation, you can replace all the following ``mamba`` commands
+    with ``conda`` and achieve the same outcome.
 
     If you are using Anaconda or Miniconda on Windows, you should open
     ``Anaconda Prompt`` instead of ``Miniforge Prompt``.
 
 Step 2:
 
-Open Terminal (on Linux or maxOS) or `Miniforge Prompt` (on Windows, **not cmd!!**).
+Open Terminal (on Linux or macOS) or `Miniforge Prompt` (on Windows, **not cmd!!**).
 Make sure you are in a conda environment - you should see ``(base)`` prepended to the
 command-line prompt, such as ``(base) C:\Users\username>``.
 
@@ -56,15 +56,15 @@ Activate the new environment with
     You will need to activate the ``andes`` environment every time
     in a new Miniforge Prompt or shell.
 
-If these steps complete without error, you now have a working Python environment.
-See the commands at the top to :ref:`getting-started` ANDES.
+If you have completed these steps without error, you now have a working Python environment.
+See the commands at the top for :ref:`getting-started`.
 
 .. _Install_extras:
 
 Extra support package
 =====================
 
-Some ANDES features require extra support packages, which are not installed by
+Some ANDES features require extra support packages that are not installed by
 default. For example, to build the documentation, one will need to install
 development packages. Other packages will be required for interoperability.
 

docs/source/getting_started/misc.rst

@@ -28,24 +28,24 @@ For example, the Line model :py:mod:`andes.models.line.Line` has parameters ``r`
 as per unit values in the device bases ``Sn``, ``Vn1``, and ``Vn2``.
 It is up to the user to check data consistency.
 For example, line voltage bases are typically the same as bus nominal values.
-If the ``r``, ``x`` and ``b`` are meant to be per unit values under the system base,
+If the ``r``, ``x``, and ``b`` are meant to be per unit values under the system base,
 each Line device should use an ``Sn`` equal to the system base mva.
 
-Parameters in device base will have a property value in the Model References page.
+Parameters in the device base will have a property value in the Model References page.
 For example, ``Line.r`` has a property ``z``, which means it is a per unit impedance
 in the device base.
 To find out all applicable properties, refer to the "Other Parameters" section of
 :py:mod:`andes.core.param.NumParam`.
 
-After setting up the system, these parameters will be converted to per units
+After setting up the system, these parameters will be converted to per-units
 in the bases of system base MVA and bus nominal voltages.
 The parameter values in the system base will be stored to the ``v`` attribute of the ``NumParam``.
 The original inputs in the device base will be moved to the ``vin`` attribute.
 For example, after setting up the system, ``Line.x.v`` is the line reactances in per unit
-under system base.
+under the system base.
 
 Values in the ``v`` attribute is what get utilized in computation.
-Writing new values directly to ``vin`` will not affect the values in ``v`` afterwards.
+Writing new values directly to ``vin`` will not affect the values in ``v``afterward.
 To alter parameters after setting up, refer to example notebook 2.
 
 Notes
@@ -59,12 +59,12 @@ State Freeze
 
 State freeze is used by converter controllers during fault transients
 to fix a variable at the pre-fault values. The concept of state freeze
-is applicable to both state or algebraic variables.
+applies to both state and algebraic variables.
 For example, in the renewable energy electric control model (REECA),
 the proportional-integral controllers for reactive power error and voltage
 error are subject to state freeze when voltage dip is observed.
 The internal and output states should be frozen when the freeze signal
-turns one and freed when the signal turns back to zero.
+turns one and frees when the signal turns back to zero.
 
 Freezing a state variable can be easily implemented by multiplying the freeze
 signal with the right-hand side (RHS) of the differential equation:
@@ -77,7 +77,7 @@ and :math:`z_f` is the freeze signal. When :math:`z_f` becomes zero
 the differential equation will evaluate to zero, making the increment
 zero.
 
-Freezing an algebraic variable is more complicate to implement.
+Freezing an algebraic variable is more difficult to implement.
 One might consider a similar solution to freezing a differential variable
 by constructing a piecewise equation, for example,
 
@@ -108,10 +108,10 @@ output, the derivatives w.r.t :math:`u`, :math:`x_i` and :math:`y` are
 nonzero in the pre-frozen state. These derivative corrects :math:`y`
 following the changes of :math:`u` and :math:`x`.
 Although :math:`x` has been frozen, if the Jacobian is not rebuilt,
-correction will still be made due to the change of :math:`u`.
+the correction will still be made due to the change of :math:`u`.
 Since this equation is linear, only one iteration is needed to let
 :math:`y` track the changes of :math:`u`.
-For nonlinear algebraic variables, this approach will likely give wrong
+For nonlinear algebraic variables, this approach will likely give the wrong
 results, since the residual is pegged at zero.
 
 To correctly freeze an algebraic variable, the freezing signal needs to
@@ -123,12 +123,12 @@ iteration after discrete components and before equations.
 
 Profiling Import
 ========================================
-To speed up the command-line program, import profiling is used to breakdown the program loading time.
+To speed up the command-line program, import profiling is used to break down the program loading time.
 
-With tool ``profimp``, ``andes`` can be profiled with ``profimp "import andes" --html > andes_import.htm``. The
-report can be viewed in any web browser.
+With tool ``profimp``, ``andes`` can be profiled with ``profimp "import andes" --html > andes_import.htm``. 
+The report can be viewed in any web browser.
 
-What won't not work
+What won't work
 ===================
 
 You might have heard that PyPy is faster than CPython due to a built-in JIT compiler.

docs/source/getting_started/overview.rst

@@ -5,17 +5,17 @@ Package Overview
 ================
 
 ANDES is an open-source Python package for power system modeling, computation,
-analysis and control. It establishes a unique **hybrid symbolic-numeric
+analysis, and control. It establishes a unique **hybrid symbolic-numeric
 framework** for modeling differential algebraic equations (DAEs) for numerical
-analysis. Main features of ANDES include
+analysis. The main features of ANDES include
 
   - a unique hybrid symbolic-numeric approach to modeling and simulation that
     enables descriptive DAE modeling and automatic numerical code generation
   - a rich library of transfer functions and discontinuous components (including
     limiters, dead-bands, and saturation) available for prototyping models,
     which can be readily instantiated as multiple devices for system analysis
   - industry-grade second-generation renewable models (solar PV, type 3 and type
-    4 wind), distributed PV and energy storage model
+    4 wind), distributed PV, and energy storage model
   - comes with the Newton method for power flow calculation, the implicit
     trapezoidal method for time-domain simulation, and full eigenvalue
     calculation
@@ -27,7 +27,7 @@ analysis. Main features of ANDES include
     of a 2000-bus system in a few seconds on a typical desktop computer
   - out-of-the-box PSS/E raw and dyr file support for available models. Once a
     model is developed, inputs from a dyr file can be readily supported
-  - an always up-to-date equation documentation of implemented models
+  - always up-to-date equation documentation of implemented models
 
 ANDES is currently under active development. To get involved,
 

docs/source/getting_started/tutorial/index.rst

@@ -4,7 +4,7 @@
 Tutorial
 ********
 ANDES can be used as a command-line tool or a library.
-The command-line interface (CLI) comes handy to run studies.
+The command-line interface (CLI) comes in handy to run studies.
 As a library, it can be used interactively in the IPython shell or the Jupyter Notebook.
 This chapter describes the most common usages.
 

docs/source/getting_started/tutorial/interactive.rst

@@ -3,19 +3,19 @@ Scripting
 =========
 This section is a tutorial for using ANDES in an interactive/scripting
 environment. All scripting shells are supported, including Python shell,
-IPython, Jupyter Notebook and Jupyter Lab. The examples below uses Jupyter
+IPython, Jupyter Notebook, and Jupyter Lab. The examples below use Jupyter
 Notebook.
 
 Jupyter Notebook
 ----------------
-Jupyter notebook is a convenient tool to run Python code and present results.
-Jupyter notebook can be installed with
+Jupyter Notebook is a convenient tool to run Python code and present results.
+Jupyter Notebook can be installed with
 
 .. code:: bash
 
     conda install jupyter notebook
 
-After the installation, change directory to the folder where you wish to store
+After the installation, change the directory to the folder where you wish to store
 notebooks, then start the notebook with
 
 .. code:: bash
@@ -27,8 +27,8 @@ create a new notebook, use the "New" button near the upper-right corner.
 
 .. note::
 
-    In the following, code that starts with ``>>>`` are Python code. and should
-    be run inside Python, IPython, or Jupyter Notebook. Python code should not
+    In the following, code blocks starting with ``>>>`` are Python code and should
+    be executed inside Python, IPython, or Jupyter Notebook. Python code should not
     be entered into Anaconda Prompt or Linux shell.
 
 Import
@@ -55,7 +55,7 @@ or simply
 
     >>> andes.config_logger(10)
 
-The ``stream_level`` uses the same verbosity levels as for the command-line. If
+The ``stream_level`` uses the same verbosity levels as for the command line. If
 not explicitly enabled, the default level 20 (INFO) will apply.
 
 To set a new logging level for the current session, call ``config_logger`` with
@@ -64,10 +64,10 @@ the desired new levels.
 Making a System
 ---------------
 Before running studies, an :py:mod:`andes.system.System` object needs to be
-create to hold the system data. The System object can be created by passing the
-path to the case file the entry-point function.
+created to hold the system data. The System object can be created by passing the
+path to the case file to the entry-point function.
 
-There are multiple ways to create such object, and :py:mod:`andes.main.run` is
+There are multiple ways to create the System object. Among them, :py:mod:`andes.main.run` is
 the most convenient way. For example, to run the file ``kundur_full.xlsx`` in
 the same directory as the notebook, use
 
@@ -93,7 +93,7 @@ system as an object. Outputs will look like ::
 In this example, ``ss`` is an instance of ``andes.System``. It contains member
 attributes for models, routines, and numerical DAE.
 
-Naming convention for the ``System`` attributes are as follows
+The naming convention for the ``System`` attributes is as follows
 
 - Model attributes share the same name as class names. For example, ``ss.Bus``
   is the ``Bus`` instance, and ``ss.GENROU`` is the ``GENROU`` instance.

docs/source/getting_started/verification.rst

@@ -8,7 +8,7 @@ This section presents the verification of the models and algorithms implemented
 in ANDES by comparing the time-domain simulation results with commercial tools.
 
 ANDES produces identical results for the IEEE 14-bus and the NPCC systems with
-several models. For the CURENT WECC system, ANDES, TSAT and PSS/E produce
+several models. For the CURENT WECC system, ANDES, TSAT, and PSS/E produce
 slightly different results. In fact, results from different tools can hardly
 match for large systems with a variety of dynamic models.
 

docs/source/index.rst

@@ -31,7 +31,7 @@ ANDES documentation
 
 LTB ANDES is an open-source Python library for power system modeling, computation,
 analysis, and control, serving as the core simulation engine for the CURENT Large scale
-Testbed (LTB). It supports power flows calculation, transient stability
+Testbed (LTB). It supports power flow calculation, transient stability
 simulation, and small-signal stability analysis for transmission systems. ANDES
 implements a symbolic-numeric framework for rapid prototyping of
 differential-algebraic equation-based models. In this framework, a comprehensive
@@ -48,7 +48,7 @@ second-generation renewable models. Models in ANDES have been :ref:`verified
     Getting started
     ^^^^^^^^^^^^^^^
 
-    New to ANDES? Check out the getting started guides. They contain tutorials
+    New to ANDES? Check out the Getting Started guides. They contain tutorials
     to the ANDES command-line interface, scripting usages, as well as guides to
     configure ANDES and work with case files.
 
@@ -65,7 +65,7 @@ second-generation renewable models. Models in ANDES have been :ref:`verified
     ^^^^^^^^
 
     The examples provide in-depth usage of ANDES in a Python scripting
-    environment. Advanced usage and and power system studies are shown with
+    environment. Advanced usage and power system studies are shown with
     explanation.
 
     +++
@@ -80,7 +80,7 @@ second-generation renewable models. Models in ANDES have been :ref:`verified
     Model development guide
     ^^^^^^^^^^^^^^^^^^^^^^^
 
-    Looking to implement new models, algorithms and functionalities in ANDES?
+    Looking to implement new models, algorithms, and functionalities in ANDES?
     The development guide provides in-depth information on the design
     philosophy, data structure, and implementation of the hybrid
     symbolic-numeric framework.