Merge branch 'doc-prod'

Author: nicolaskruchten

Diff for: doc/python/figure-structure.md

@@ -5,8 +5,8 @@ jupyter:
     text_representation:
       extension: .md
       format_name: markdown
-      format_version: '1.2'
-      jupytext_version: 1.6.0
+      format_version: '1.3'
+      jupytext_version: 1.11.4
   kernelspec:
     display_name: Python 3
     language: python
@@ -20,7 +20,7 @@ jupyter:
     name: python
     nbconvert_exporter: python
     pygments_lexer: ipython3
-    version: 3.7.6
+    version: 3.8.11
   plotly:
     description: The structure of a figure - data, traces and layout explained.
     display_as: file_settings
@@ -93,7 +93,7 @@ The second of the three top-level attributes of a figure is `layout`, whose valu
   * Subplots of various types on which can be drawn multiple traces and which are positioned in paper coordinates:
     * `xaxis`, `yaxis`, `xaxis2`, `yaxis3` etc: X and Y cartesian axes, the intersections of which are cartesian subplots
     * `scene`, `scene2`, `scene3` etc: 3d scene subplots
-    * `ternary`, `ternary2`, `ternary3`, `polar`, `polar2`, `polar3`, `geo`, `geo2`, `geo3`, `mapbox`, `mapbox2`, `mabox3` etc: ternary, polar, geo or mapbox subplots
+    * `ternary`, `ternary2`, `ternary3`, `polar`, `polar2`, `polar3`, `geo`, `geo2`, `geo3`, `mapbox`, `mapbox2`, `mabox3`, `smith`, `smith2` etc: ternary, polar, geo, mapbox or smith subplots
   * Non-data marks which can be positioned in paper coordinates, or in data coordinates linked to 2d cartesian subplots:
     * `annotations`: [textual annotations with or without arrows](/python/text-and-annotations/)
     * `shapes`: [lines, rectangles, ellipses or open or closed paths](/python/shapes/)
@@ -151,9 +151,9 @@ The following trace types are compatible with 2d-cartesian subplots via the `xax
 * [`carpet`](/python/carpet-plot/): a special trace type for building [carpet plots](/python/carpet-plot/), in that other traces can use as subplots (see below)
 * [`splom`](/python/splom/): multi-dimensional scatter plots which implicitly refer to many 2-d cartesian subplots at once.
 
-### 3D, Polar and Ternary Trace Types and Subplots
+### 3D, Polar, Ternary and Smith Trace Types and Subplots
 
-Beyond 2D cartesian subplots, figures can include [three-dimensional cartesian subplots](/python/3d-charts/), [polar subplots](/python/polar-chart/) and [ternary subplots](/python/ternary-plots/). The following trace types support attributes named `scene`, `polar` or `ternary`, whose values must refer to corresponding objects in the layout portion of the figure i.e. `ternary="ternary2"` etc. Note that attributes such as `layout.scene` and `layout.ternary2` etc do not have to be explicitly defined, in which case default values will be inferred. Multiple traces of a compatible type can be placed on the same subplot.
+Beyond 2D cartesian subplots, figures can include [three-dimensional cartesian subplots](/python/3d-charts/), [polar subplots](/python/polar-chart/), [ternary subplots](/python/ternary-plots/) and [smith subplots](/python/smith-charts/). The following trace types support attributes named `scene`, `polar`, `smith` or `ternary`, whose values must refer to corresponding objects in the layout portion of the figure i.e. `ternary="ternary2"` etc. Note that attributes such as `layout.scene` and `layout.ternary2` etc do not have to be explicitly defined, in which case default values will be inferred. Multiple traces of a compatible type can be placed on the same subplot.
 
 The following trace types are compatible with 3D subplots via the `scene` attribute, which contains special [camera controls](/python/3d-camera-controls/):
 
@@ -171,6 +171,10 @@ The following trace types are compatible with ternary subplots via the `ternary`
 
 * [`scatterternary`](/python/ternary-plots/), which can be used to draw individual markers, [curves and filled areas](/python/ternary-contour/)
 
+The following trace types are compatible with smith subplots via the `smith` attribute:
+
+* [`scattersmith`](/python/smith-charts/), which can be used to draw individual markers, curves and filled areas
+
 ### Map Trace Types and Subplots
 
 Figures can include two different types of map subplots: [geo subplots for outline maps](/python/map-configuration/) and [mapbox subplots for tile maps](/python/mapbox-layers/). The following trace types support attributes named `geo` or `mapbox`, whose values must refer to corresponding objects in the layout i.e. `geo="geo2"` etc.  Note that attributes such as `layout.geo2` and `layout.mapbox` etc do not have to be explicitly defined, in which case default values will be inferred. Multiple traces of a compatible type can be placed on the same subplot.

Diff for: doc/python/smith-charts.md

@@ -0,0 +1,96 @@
+---
+jupyter:
+  jupytext:
+    notebook_metadata_filter: all
+    text_representation:
+      extension: .md
+      format_name: markdown
+      format_version: '1.3'
+      jupytext_version: 1.11.4
+  kernelspec:
+    display_name: Python 3
+    language: python
+    name: python3
+  language_info:
+    codemirror_mode:
+      name: ipython
+      version: 3
+    file_extension: .py
+    mimetype: text/x-python
+    name: python
+    nbconvert_exporter: python
+    pygments_lexer: ipython3
+    version: 3.8.11
+  plotly:
+    description: How to make Smith Charts with plotly.
+    display_as: scientific
+    language: python
+    layout: base
+    name: Smith Charts
+    order: 21
+    page_type: u-guide
+    permalink: python/smith-charts/
+    thumbnail: thumbnail/contourcarpet.jpg
+---
+
+A [Smith Chart](https://en.wikipedia.org/wiki/Smith_chart) is a specialized chart for visualizing [complex numbers](https://en.wikipedia.org/wiki/Complex_number): numbers with both a real and imaginary part.
+
+
+### Smith Charts with Plotly Graph Objects
+
+```python
+import plotly.graph_objects as go
+
+fig = go.Figure(go.Scattersmith(imag=[0.5, 1, 2, 3], real=[0.5, 1, 2, 3]))
+fig.show()
+```
+
+### Smith Chart Subplots and Styling
+
+```python
+import plotly.graph_objects as go
+
+fig = go.Figure()
+
+fig.add_trace(go.Scattersmith(
+    imag=[1], 
+    real=[1],
+    marker_symbol='x',
+    marker_size=30,
+    marker_color="green",
+    subplot="smith1"
+))
+
+fig.add_trace(go.Scattersmith(
+    imag=[1], 
+    real=[1],
+    marker_symbol='x',
+    marker_size=30,
+    marker_color="pink",
+    subplot="smith2"
+))
+
+fig.update_layout(
+    smith=dict(
+        realaxis_gridcolor='red',
+        imaginaryaxis_gridcolor='blue',
+        domain=dict(x=[0,0.45])
+    ),
+    smith2=dict(
+        realaxis_gridcolor='blue',
+        imaginaryaxis_gridcolor='red',
+        domain=dict(x=[0.55,1])
+    )
+)
+
+fig.update_smiths(bgcolor="lightgrey")
+
+fig.show()
+```
+
+#### Reference
+See https://plotly.com/python/reference/scattersmith/ and https://plotly.com/python/reference/layout/smith/ for more information and chart attribute options!
+
+```python
+
+```