DOC: including spheroids doc in the tree

lavakyan · Mar 5, 2021 · 1f730ce · 1f730ce
1 parent dbec692
commit 1f730ce
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 6 deletions.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -26,7 +26,7 @@
 # The short X.Y version
 version = ''
 # The full version, including alpha/beta/rc tags
-release = '1.0.1'
+release = '1.0.2'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/doc/source/scripting/nonspherical.rst b/doc/source/scripting/nonspherical.rst
@@ -10,8 +10,16 @@ Currently supported only spheroid shape (rotational ellipsoid) using external li
 Example
 ^^^^^^^
 
-Calculation of extinction for oblate spheroid with aspect ratio of 1.5. 
-The size is specified by diamter of equivalent-volume sphere.
+Calculation of extinction for oblate spheroid with aspect ratio of :math:`\alpha=a/c=`1.5. 
+The size is specified by diamter :math:`a_{eff}` of equivalent-volume sphere.
+
+The spheroid size can be derived as
+
+.. math::
+
+   a = a_{eff} \alpha^{1/3} \\
+   c = a / \alpha
+
 
 
 .. literalinclude:: spheroid_contrib.py

diff --git a/doc/source/scripting/scripting.rst b/doc/source/scripting/scripting.rst
@@ -12,6 +12,7 @@ Use Python scripts for full control of calculations.
    materials
    contribs
    spheres
+   nonspherical
    fitting
 
 

diff --git a/meta.yaml b/meta.yaml
@@ -1,6 +1,6 @@
 package:
   name: mstm_studio
-  version: 1.0.1
+  version: 1.0.2
 
 build:
   noarch: python
@@ -11,4 +11,4 @@ requirements:
   run:
     - python
 about:
-  summary: Python wrapper for multiple sphere T-matrix (MSTM) code and Mie theory to calculate surface plasmon resonance (SPR) spectrum and *fit* it to experiment.
+  summary: Python wrapper for multiple sphere T-matrix (MSTM) code and Mie theory to calculate surface plasmon resonance (SPR) spectrum and *fit* it to experiment.
diff --git a/mstm_studio/__init__.py b/mstm_studio/__init__.py
@@ -1 +1 @@
-__version__ = '1.0.1'
+__version__ = '1.0.2'