update documentation

Author: otvam

README.md

@@ -28,45 +28,45 @@ The code is written in **Python** and is fully **open source**!
 
 **PyPEEC** features the following **characteristics**:
 
-* **PEEC method** with **FFT acceleration**
-* **Fast** with **moderate memory** requirements
-* Representation of the **geometry** with **3D voxels**
-* **Parallel processing** and **GPU acceleration** are available
-* Import the **geometry** from **STL**, **PNG**, and **GERBER** files
-* Draw the **geometry** with stacked 2D **vector shapes** or **voxel indices**
-* **Pure Python** and **open source** implementation
-* Can be used from the **command line** pr with an **API**
-* Advanced **plotting and visualization** capabilities
-* Compatible with **Jupyter notebooks**
-* Compatible with **ParaView**
+* **PEEC method** with **FFT acceleration**.
+* **Fast** with **moderate memory** requirements.
+* Representation of the **geometry** with **3D voxels**.
+* **Parallel processing** and **GPU acceleration** are available.
+* Import the **geometry** from **STL**, **PNG**, and **GERBER** files.
+* Draw the **geometry** with stacked 2D **vector shapes** or **voxel indices**.
+* **Pure Python** and **open source** implementation.
+* Can be used from the **command line** pr with an **API**.
+* Advanced **plotting and visualization** capabilities.
+* Compatible with **Jupyter notebooks**.
+* Compatible with **ParaView**.
 
 **PyPEEC** solves the following **3D quasi-magnetostatic problems**:
 
-* Frequency domain solution (DC and AC)
-* Conductive and magnetic domains (ideal or lossy)
-* Isotropic, anisotropic, lumped, and distributed materials
-* Connection of current and voltage sources
-* Extraction of the current density, flux density, and potential
-* Extraction of the terminal voltage, current, and power
-* Computation of the free-space magnetic field 
+* Frequency domain solution (DC and AC).
+* Conductive and magnetic domains (ideal or lossy).
+* Isotropic, anisotropic, lumped, and distributed materials.
+* Connection of current and voltage sources.
+* Extraction of the current density, flux density, and potential.
+* Extraction of the terminal voltage, current, and power.
+* Computation of the free-space magnetic field .
 
 **PyPEEC** has the following **limitations**:
 
-* No capacitive effects
-* No dielectric domains
-* No force computations
-* No advanced boundaries conditions
-* No domain decomposition techniques
-* No hierarchical matrix techniques
-* No model order reduction techniques
-* Limited to voxel geometries
+* No capacitive effects.
+* No dielectric domains.
+* No force computations.
+* No advanced boundaries conditions.
+* No domain decomposition techniques.
+* No hierarchical matrix techniques.
+* No model order reduction techniques.
+* Limited to voxel geometries.
 
 The **PyPEEC** package contains the following **tools**:
 
-* **mesher** - create a 3D voxel structure from STL or PNG files
-* **viewer** - visualization of the 3D voxel structure
-* **solver** - solver for the quasi-magnetostatic problem
-* **plotter** - visualization of the problem solution
+* **mesher** - Create a 3D voxel structure from the geometry.
+* **viewer** - Visualization of the 3D voxel structure.
+* **solver** - Solve the quasi-magnetostatic problem.
+* **plotter** - Visualization of the problem solution.
 
 ## Warning
 

docs/content/examples.rst

@@ -6,21 +6,21 @@ Running the Examples
 
 * Extract the examples with the ``pypeec examples`` command.
 
-* For running the examples from **Python**:
+* For running the examples with **Python**:
 
-  * ``examples_config.py`` is used to select the example
-  * ``run_mesher.py`` runs the mesher
-  * ``run_viewer.py`` runs the viewer
-  * ``run_solver.py`` runs the solver
-  * ``run_plotter.py`` runs the plotter
+  * ``examples_config.py`` is used to select the example.
+  * ``run_mesher.py`` runs the mesher.
+  * ``run_viewer.py`` runs the viewer.
+  * ``run_solver.py`` runs the solver.
+  * ``run_plotter.py`` runs the plotter.
 
 * For running the examples from the **Shell**:
 
-  * ``examples_config.sh`` is used to select the example
-  * ``run_mesher.sh`` runs the mesher
-  * ``run_viewer.sh`` runs the viewer
-  * ``run_solver.sh`` runs the solver
-  * ``run_plotter.sh`` runs the plotter
+  * ``examples_config.sh`` is used to select the example.
+  * ``run_mesher.sh`` runs the mesher.
+  * ``run_viewer.sh`` runs the viewer.
+  * ``run_solver.sh`` runs the solver.
+  * ``run_plotter.sh`` runs the plotter.
 
 * For running the examples from a **Jupyter notebook**, use ``notebook.ipynb``:
 
@@ -33,42 +33,42 @@ STL Mesher Examples
 examples_stl/inductor_air
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **STL files**
-* **3D air-core spiral inductor**
+* Defined with **STL files**.
+* **3D air-core spiral inductor**.
 
 .. image:: ../examples/examples_stl/inductor_air.png
 
 examples_stl/inductor_core
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **STL files**
-* **3D inductor with a magnetic E-core**
+* Defined with **STL files**.
+* **3D inductor with a magnetic E-core**.
 
 .. image:: ../examples/examples_stl/inductor_core.png
 
 examples_stl/inductor_toroid
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **STL files**
-* **3D inductor with a toroidal core**
+* Defined with **STL files**.
+* **3D inductor with a toroidal core**.
 
 .. image:: ../examples/examples_stl/inductor_toroid.png
 
 examples_stl/transformer_core
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **STL files**
-* **Transformer with two windings and a magnetic core**
+* Defined with **STL files**.
+* **Transformer with two windings and a magnetic core**.
 
 .. image:: ../examples/examples_stl/transformer_core.png
 
 examples_stl/transformer_air
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **STL files**
-* **Planar air-core transformer with two windings**
-* Extraction of the **impedance matrix** from the solution
-* Example for the extraction of the impedance matrix: ``run_matrix.py``
+* Defined with **STL files**.
+* **Planar air-core transformer with two windings**.
+* Extraction of the **impedance matrix** from the solution.
+* Example for the extraction of the impedance matrix: ``run_matrix.py``.
 
 .. image:: ../examples/examples_stl/transformer_air.png
 
@@ -78,50 +78,50 @@ Shape Mesher Examples
 examples_shape/busbar
 ^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **2D shapes**
-* **Coplanar L-shaped busbar**
+* Defined with **2D shapes**.
+* **Coplanar L-shaped busbar**.
 
 .. image:: ../examples/examples_shape/busbar.png
 
 examples_shape/coplanar
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **2D shapes**
-* **PCB with coplanar traces**
+* Defined with **2D shapes**.
+* **PCB with coplanar traces**.
 
 .. image:: ../examples/examples_shape/coplanar.png
 
 examples_shape/parallel
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **2D shapes**
-* **Parallel wires with opposing currents**
+* Defined with **2D shapes**.
+* **Parallel wires with opposing currents**.
 
 .. image:: ../examples/examples_shape/parallel.png
 
 examples_shape/hole
 ^^^^^^^^^^^^^^^^^^^
 
-* Defined with **2D shapes**
-* **Single PCB trace with a hole**
+* Defined with **2D shapes**.
+* **Single PCB trace with a hole**.
 
 .. image:: ../examples/examples_shape/hole.png
 
 examples_shape/wire
 ^^^^^^^^^^^^^^^^^^^
 
-* Defined with **2D shapes**
-* **Single straight round wire**
+* Defined with **2D shapes**.
+* **Single straight round wire**.
 
 .. image:: ../examples/examples_shape/wire.png
 
 examples_shape/pwm
 ^^^^^^^^^^^^^^^^^^
 
-* Defined with **2D shapes**
-* **Planar spiral inductor**
-* **Non-sinusoidal** analysis with **Fourier** series
-* Example for the frequency domain analysis: ``run_fourier.py``
+* Defined with **2D shapes**.
+* **Planar spiral inductor**.
+* **Non-sinusoidal** analysis with **Fourier** series.
+* Example for the frequency domain analysis: ``run_fourier.py``.
 
 .. image:: ../examples/examples_shape/pwm.png
 
@@ -132,50 +132,50 @@ PNG Mesher Examples
 examples_png/inductor_spiral
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **PNG files**
-* **Planar spiral inductor**
+* Defined with **PNG files**.
+* **Planar spiral inductor**.
 
 .. image:: ../examples/examples_png/inductor_spiral.png
 
 examples_png/inductor_gap
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **PNG files**
-* **Gapped inductor with a magnetic E-core**
+* Defined with **PNG files**.
+* **Gapped inductor with a magnetic E-core**.
 
 .. image:: ../examples/examples_png/inductor_gap.png
 
 examples_png/inductor_pot
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **PNG files**
-* **Pot-core inductor with external gap**
+* Defined with **PNG files**.
+* **Pot-core inductor with external gap**.
 
 .. image:: ../examples/examples_png/inductor_pot.png
 
 examples_png/iron_core
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **PNG files**
-* **Iron magnetic core with a non-zero resistivity**
+* Defined with **PNG files**.
+* **Iron magnetic core with a non-zero resistivity**.
 
 .. image:: ../examples/examples_png/iron_core.png
 
 examples_png/shield
 ^^^^^^^^^^^^^^^^^^^
 
-* Defined with **PNG files**
-* **Conductor loop with a magnetic shield**
+* Defined with **PNG files**.
+* **Conductor loop with a magnetic shield**.
 
 .. image:: ../examples/examples_png/shield.png
 
 examples_png/gerber
 ^^^^^^^^^^^^^^^^^^^
 
-* Defined with **PNG files**
-* **PCB inductor defined with GERBER files**
-* Generation of the PNG files from **GERBER files**
-* Example for parsing the GERBER files: ``run_gerber.py``
+* Defined with **PNG files**.
+* **PCB inductor defined with GERBER files**.
+* Generation of the PNG files from **GERBER files**.
+* Example for parsing the GERBER files: ``run_gerber.py``.
 
 .. image:: ../examples/examples_png/gerber.png
 
@@ -185,49 +185,49 @@ Voxel Mesher Examples
 examples_voxel/slab
 ^^^^^^^^^^^^^^^^^^^
 
-* Defined with **voxel indices**
-* **Simple slab conductor in free space**
+* Defined with **voxel indices**.
+* **Simple slab conductor in free space**.
 
 .. image:: ../examples/examples_voxel/slab.png
 
 examples_voxel/transformer
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **voxel indices**
-* **Simple transformer with a short-circuited winding**
+* Defined with **voxel indices**.
+* **Simple transformer with a short-circuited winding**.
 
 .. image:: ../examples/examples_voxel/transformer.png
 
 examples_voxel/anisotropic
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **voxel indices**
-* **L-shaped conductor with anisotropic resistivity**
+* Defined with **voxel indices**.
+* **L-shaped conductor with anisotropic resistivity**.
 
 .. image:: ../examples/examples_voxel/anisotropic.png
 
 examples_voxel/distributed
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Defined with **voxel indices**
-* **Slab conductor with space dependent resistivity**
+* Defined with **voxel indices**.
+* **Slab conductor with space dependent resistivity**.
 
 .. image:: ../examples/examples_voxel/distributed.png
 
 examples_voxel/logo
 ^^^^^^^^^^^^^^^^^^^
 
-* Defined with **voxel indices**
-* **Simple geometry used for the PyPEEC logo**
+* Defined with **voxel indices**.
+* **Simple geometry used for the PyPEEC logo**.
 
 .. image:: ../examples/examples_voxel/logo.png
 
 examples_voxel/core
 ^^^^^^^^^^^^^^^^^^^
 
-* Defined with **voxel indices**
-* **Simple slab conductor surrounded by a magnetic core**
-* **Procedural generation** of the voxel indices (1D and 3D)
-* Example for generating the voxel indices: ``run_voxel.py``
+* Defined with **voxel indices**.
+* **Simple slab conductor surrounded by a magnetic core**.
+* **Procedural generation** of the voxel indices (1D and 3D).
+* Example for generating the voxel indices: ``run_voxel.py``.
 
 .. image:: ../examples/examples_voxel/core.png

docs/content/install.rst

@@ -4,15 +4,15 @@ Installation
 Available Packages
 ------------------
 
-* **Python Package** - available through PyPI
-* **Conda Package** - available through conda-forge
-* **Dockerfile** - Ubuntu image with PyPEEC and Jupyter
+* **Python Package** - Available through PyPI.
+* **Conda Package** - Available through conda-forge.
+* **Dockerfile** - Ubuntu image with PyPEEC and Jupyter.
 
 The following **optional libraries are not included** in the PyPI/Conda package:
 
-* **HPC libraries** - FFTW, PyAMG, MKL/FFT, and MKL/PARDISO
-* **Notebook support** - JupyterLab, IPyWidgets, Trame, and ipympl
-* **GPU libraries** - CuPy and CUDA
+* **HPC libraries** - FFTW, PyAMG, MKL/FFT, and MKL/PARDISO.
+* **Notebook support** - JupyterLab, IPyWidgets, and Trame.
+* **GPU libraries** - CuPy and CUDA.
 
 Some **important remarks** about the **PyPI/Conda packages**: