From acdd58f5a20eb8e6a91d196891464f422f4d8761 Mon Sep 17 00:00:00 2001 From: satabol Date: Thu, 1 Sep 2022 00:55:40 +0300 Subject: [PATCH] Update docs and images, some errata --- .../generators_extended/pentagon_tiler.rst | 2 +- docs/nodes/generators_extended/triangle.rst | 2 +- docs/nodes/list_main/constant.rst | 47 ++++++++-- docs/nodes/list_main/decompose.rst | 20 ++++- docs/nodes/list_main/func.rst | 9 +- docs/nodes/list_main/index.rst | 18 +++- docs/nodes/list_main/join.rst | 9 +- docs/nodes/list_main/length.rst | 17 +++- docs/nodes/list_main/statistics.rst | 90 ++++++++++--------- docs/nodes/list_main/sum_mk2.rst | 9 +- docs/nodes/list_main/zip.rst | 9 +- 11 files changed, 173 insertions(+), 59 deletions(-) diff --git a/docs/nodes/generators_extended/pentagon_tiler.rst b/docs/nodes/generators_extended/pentagon_tiler.rst index 89cc823c6e..c653215024 100644 --- a/docs/nodes/generators_extended/pentagon_tiler.rst +++ b/docs/nodes/generators_extended/pentagon_tiler.rst @@ -41,7 +41,7 @@ In the N-Panel (and on the right-click menu) you can find: **Angle Units**: Choose if the input angles will be interpreted as Degrees or Radians -**Flat output**: Flatten output by list-joining level 1 and unwarping it (default set to True) +**Flat output**: Flatten output by list-joining level 1 and unwraping it (default set to True) **Match List Global**: Define how list with different lengths should be matched. Refers to the matching of groups (level 1) diff --git a/docs/nodes/generators_extended/triangle.rst b/docs/nodes/generators_extended/triangle.rst index 4a28a865f3..f9caf14bd8 100644 --- a/docs/nodes/generators_extended/triangle.rst +++ b/docs/nodes/generators_extended/triangle.rst @@ -51,7 +51,7 @@ In the N-Panel (and on the right-click menu) you can find: **Tolerance**: Removing Doubles Tolerance (only active when "Remove Doubles" is True) -**Flat output**: Flatten output by list-joining level 1 and unwarping it (default set to True) +**Flat output**: Flatten output by list-joining level 1 and unwraping it (default set to True) **Match List Global**: Define how list with different lengths should be matched. Refers to the matching of groups (level 1) diff --git a/docs/nodes/list_main/constant.rst b/docs/nodes/list_main/constant.rst index 0cbbf9bdc7..67887ff43b 100644 --- a/docs/nodes/list_main/constant.rst +++ b/docs/nodes/list_main/constant.rst @@ -2,6 +2,7 @@ Constant List ============= .. image:: https://user-images.githubusercontent.com/14288520/187515870-f8b16699-e1f4-49bd-b398-5077539e2aba.png + :target: https://user-images.githubusercontent.com/14288520/187515870-f8b16699-e1f4-49bd-b398-5077539e2aba.png Functionality ------------- @@ -50,25 +51,61 @@ Examples of usage A simple example: -.. image:: https://user-images.githubusercontent.com/284644/74590945-286de180-5035-11ea-8c88-949ce11beb1c.png +.. image:: https://user-images.githubusercontent.com/14288520/187686031-a9e200c0-de63-4021-950f-c4cff8c855a9.png + :target: https://user-images.githubusercontent.com/14288520/187686031-a9e200c0-de63-4021-950f-c4cff8c855a9.png + +* Text-> :doc:`Stethoscope ` +* Text-> :doc:`Data Shape ` If **Output level** would be 1 in this setup, the result would be `[0.06, 0.06, 0.06]`. If **Output level** would be 3, the result would be `[[[0.06, -0.06, 0.06]]]`. +0.06, 0.06]]]`: + +.. image:: https://user-images.githubusercontent.com/14288520/187686049-9e05a419-95f7-46c8-bc62-08beaee85589.png + :target: https://user-images.githubusercontent.com/14288520/187686049-9e05a419-95f7-46c8-bc62-08beaee85589.png + +* Text-> :doc:`Stethoscope ` +* Text-> :doc:`Data Shape ` More complex example: -.. image:: https://user-images.githubusercontent.com/284644/74590944-27d54b00-5035-11ea-8d62-6aeeac135e6e.png +.. image:: https://user-images.githubusercontent.com/14288520/187686059-70276803-32bd-4855-8bc3-4e2616bb0e0e.png + :target: https://user-images.githubusercontent.com/14288520/187686059-70276803-32bd-4855-8bc3-4e2616bb0e0e.png + +* Number-> :doc:`List Input ` +* Text-> :doc:`Stethoscope ` +* Text-> :doc:`Data Shape ` + If **Output level** would be 1 in this setup, the result would be `[1, 1, 1, 2, 2, 2, 2, 2]`. If **Output level** would be 3, the result would be `[[[1, 1, 1], -[2, 2, 2, 2, 2]]]`. +[2, 2, 2, 2, 2]]]`: + +.. image:: https://user-images.githubusercontent.com/14288520/187686070-80366925-2893-470d-b6af-6651d6825b26.png + :target: https://user-images.githubusercontent.com/14288520/187686070-80366925-2893-470d-b6af-6651d6825b26.png + +* Number-> :doc:`List Input ` +* Text-> :doc:`Stethoscope ` +* Text-> :doc:`Data Shape ` Another complex example: -.. image:: https://user-images.githubusercontent.com/284644/74590942-273cb480-5035-11ea-9ed7-84da04e3d590.png +.. image:: https://user-images.githubusercontent.com/14288520/187688679-f97b4d33-989f-4406-8fb7-fec0df09a056.png + :target: https://user-images.githubusercontent.com/14288520/187688679-f97b4d33-989f-4406-8fb7-fec0df09a056.png + +* Number-> :doc:`List Input ` +* List->List Main-> :doc:`List Join ` +* Text-> :doc:`Stethoscope ` +* Text-> :doc:`Data Shape ` If **Output level** would be 1 in this setup, the result would be `[1, 1, 1, 2, 2, 2, 2, 2, 3, 3, 3, 4, 4, 4, 4, 4]`. If **Output level** would be 2, the result would be `[[1, 1, 1], [2, 2, 2, 2, 2], [3, 3, 3], [4, 4, 4, 4, 4]]`. +.. image:: https://user-images.githubusercontent.com/14288520/187688692-bcf57546-26b8-4f01-85a6-280942092053.png + :target: https://user-images.githubusercontent.com/14288520/187688692-bcf57546-26b8-4f01-85a6-280942092053.png + +* Number-> :doc:`List Input ` +* List->List Main-> :doc:`List Join ` +* Text-> :doc:`Stethoscope ` +* Text-> :doc:`Data Shape ` \ No newline at end of file diff --git a/docs/nodes/list_main/decompose.rst b/docs/nodes/list_main/decompose.rst index a17f3d3119..bab0937e88 100644 --- a/docs/nodes/list_main/decompose.rst +++ b/docs/nodes/list_main/decompose.rst @@ -2,6 +2,7 @@ List Decompose ============== .. image:: https://user-images.githubusercontent.com/14288520/187529767-1291c5cd-40cd-45b6-a44c-78c02e8c33c5.png + :target: https://user-images.githubusercontent.com/14288520/187529767-1291c5cd-40cd-45b6-a44c-78c02e8c33c5.png Functionality ------------- @@ -39,9 +40,10 @@ Example of usage **Decomposed simple list in 2 level:** .. image:: https://user-images.githubusercontent.com/14288520/187661007-c9b8a9c2-d62c-4d32-9f3b-c9326ec411a5.png + :target: https://user-images.githubusercontent.com/14288520/187661007-c9b8a9c2-d62c-4d32-9f3b-c9326ec411a5.png -:doc:`Number->Number range `, -:doc:`Text->Stethoscope MK2 ` +* Number-> :doc:`Number Range ` +* Text-> :doc:`Stethoscope ` **Use 'Auto set' button:** @@ -49,7 +51,19 @@ Example of usage 2. Press Auto set .. image:: https://user-images.githubusercontent.com/14288520/187530201-2c9fa567-486e-49d6-9c7c-8138b5dfcbe1.png + :target: https://user-images.githubusercontent.com/14288520/187530201-2c9fa567-486e-49d6-9c7c-8138b5dfcbe1.png + +* Number-> :doc:`List Input ` +* Text-> :doc:`Stethoscope ` **Decompose list of Bezier Curves:** -.. image:: https://user-images.githubusercontent.com/14288520/187531176-a495c440-f76b-49a4-adc5-5bd66e65a869.png \ No newline at end of file +.. image:: https://user-images.githubusercontent.com/14288520/187531176-a495c440-f76b-49a4-adc5-5bd66e65a869.png + :target: https://user-images.githubusercontent.com/14288520/187531176-a495c440-f76b-49a4-adc5-5bd66e65a869.png + +* Curve-> :doc:`Bezier Spline (Curve) ` +* List->List Main-> :doc:`List Join ` +* Curve-> :doc:`Evaluate Curve ` +* Viz-> :doc:`Viewer Draw ` +* Text-> :doc:`Stethoscope ` + diff --git a/docs/nodes/list_main/func.rst b/docs/nodes/list_main/func.rst index 9a4273069c..eaca72cefd 100644 --- a/docs/nodes/list_main/func.rst +++ b/docs/nodes/list_main/func.rst @@ -2,6 +2,7 @@ List Math ========= .. image:: https://user-images.githubusercontent.com/14288520/187527983-9ecef862-b83b-460e-bc7a-eda13ca91252.png + :target: https://user-images.githubusercontent.com/14288520/187527983-9ecef862-b83b-460e-bc7a-eda13ca91252.png Functionality ------------- @@ -31,7 +32,7 @@ Logical OR Return True if any value in the list is logical True Logical AND Return True if all values in the list are logical True =================== ====================================== -**Warp:** Adds one level of warping (output becomes [output]) +**Wrap:** Adds one level of wraping (output becomes [output]) Outputs ------- @@ -43,7 +44,11 @@ The output is always going to be a number, integer or float, depending on the in Examples -------- -.. image:: https://cloud.githubusercontent.com/assets/5990821/4191546/dd4edc6e-378e-11e4-8015-8f66ec59b68e.png +.. image:: https://user-images.githubusercontent.com/14288520/187716616-57161d36-4b66-4680-b5bc-e94304944c46.png :alt: ListMathDemo1.PNG + :target: https://user-images.githubusercontent.com/14288520/187716616-57161d36-4b66-4680-b5bc-e94304944c46.png + +* Number-> :doc:`Number Range ` +* Text-> :doc:`Data Shape ` In this example the node shows all the possible outputs. diff --git a/docs/nodes/list_main/index.rst b/docs/nodes/list_main/index.rst index a5f104859d..88c8be294d 100644 --- a/docs/nodes/list_main/index.rst +++ b/docs/nodes/list_main/index.rst @@ -2,6 +2,7 @@ List Index ========== .. image:: https://user-images.githubusercontent.com/14288520/187533476-0cce7810-4f52-4997-92d9-6ffac7c0669f.png + :target: https://user-images.githubusercontent.com/14288520/187533476-0cce7810-4f52-4997-92d9-6ffac7c0669f.png Functionality ------------- @@ -39,8 +40,23 @@ Examples **Finding index of maximum value in array of random values** -.. image:: https://user-images.githubusercontent.com/28003269/107858186-57878080-6e4c-11eb-84a4-3f23260caa9f.png +.. image:: https://user-images.githubusercontent.com/14288520/187765990-caf44dc8-02f9-4568-be60-f805442deb57.png + :target: https://user-images.githubusercontent.com/14288520/187765990-caf44dc8-02f9-4568-be60-f805442deb57.png + + +* Number-> :doc:`Random Num Gen ` +* List->List Main-> :doc:`List Math ` +* List->List Main-> :doc:`List Index ` +* List->List Struct-> :doc:`List Item ` +* Text-> :doc:`Stethoscope ` **Finding several indices:** .. image:: https://user-images.githubusercontent.com/14288520/187533943-79991e77-371a-48ad-bc93-5073691c2beb.png + :target: https://user-images.githubusercontent.com/14288520/187533943-79991e77-371a-48ad-bc93-5073691c2beb.png + +"-1" - Not found + +* Number-> :doc:`Number Range ` +* Number-> :doc:`List Input ` +* Text-> :doc:`Stethoscope ` diff --git a/docs/nodes/list_main/join.rst b/docs/nodes/list_main/join.rst index acdb77b48e..5da0dfea5d 100644 --- a/docs/nodes/list_main/join.rst +++ b/docs/nodes/list_main/join.rst @@ -2,6 +2,7 @@ List Join ========= .. image:: https://user-images.githubusercontent.com/14288520/187512380-c7e79c39-f868-489a-879d-dd3a063dea53.png + :target: https://user-images.githubusercontent.com/14288520/187512380-c7e79c39-f868-489a-879d-dd3a063dea53.png Functionality ------------- @@ -79,4 +80,10 @@ Examples **Combine Bezier Spline Curves with 'List Join' node to Create a Surface** -.. image:: https://user-images.githubusercontent.com/14288520/187514973-08b68caf-2024-4316-b2d5-834d49f96712.png \ No newline at end of file +.. image:: https://user-images.githubusercontent.com/14288520/187514973-08b68caf-2024-4316-b2d5-834d49f96712.png + :target: https://user-images.githubusercontent.com/14288520/187514973-08b68caf-2024-4316-b2d5-834d49f96712.png + +* Curve-> :doc:`Bezier Spline (Curve) ` +* Surfaces-> :doc:`Surface from Curves ` +* Surfaces-> :doc:`Evaluate Surfaces ` +* Viz-> :doc:`Viewer Draw ` \ No newline at end of file diff --git a/docs/nodes/list_main/length.rst b/docs/nodes/list_main/length.rst index acd57d7eaf..6a0b542f79 100644 --- a/docs/nodes/list_main/length.rst +++ b/docs/nodes/list_main/length.rst @@ -2,6 +2,7 @@ List Length =========== .. image:: https://user-images.githubusercontent.com/14288520/187519011-8e55b053-801f-43f1-9d45-727a11633ca1.png + :target: https://user-images.githubusercontent.com/14288520/187519011-8e55b053-801f-43f1-9d45-727a11633ca1.png Functionality ------------- @@ -29,8 +30,18 @@ Examples Often a few experiments with input hooked-up to a debug node will make the exact working of this Node instantly clearer than any explanation. -.. image:: https://cloud.githubusercontent.com/assets/619340/4186453/1a375026-3761-11e4-8e41-11b57736be1a.PNG +.. image:: https://user-images.githubusercontent.com/14288520/187696438-05bf888a-086e-4a49-a6e6-0752ce3ef475.png :alt: ListLengthDemo1.PNG + :target: https://user-images.githubusercontent.com/14288520/187696438-05bf888a-086e-4a49-a6e6-0752ce3ef475.png -.. image:: https://cloud.githubusercontent.com/assets/619340/4186454/1a3de7b0-3761-11e4-9520-79b331ad6822.PNG - :alt: ListLengthDemo2.PNG \ No newline at end of file +* Vector-> :doc:`Vector X/Y/Z ` +* Number-> :doc:`Number Range ` +* Matrix-> :doc:`Matrix In ` +* Text-> :doc:`Stethoscope ` + +.. image:: https://user-images.githubusercontent.com/14288520/187696469-0fba9dff-0423-406c-9a19-7ef0d607d996.png + :alt: ListLengthDemo2.PNG + :target: https://user-images.githubusercontent.com/14288520/187696469-0fba9dff-0423-406c-9a19-7ef0d607d996.png + +* Number-> :doc:`Number Range ` +* Text-> :doc:`Stethoscope ` \ No newline at end of file diff --git a/docs/nodes/list_main/statistics.rst b/docs/nodes/list_main/statistics.rst index b01bd20c89..e36b5e235c 100644 --- a/docs/nodes/list_main/statistics.rst +++ b/docs/nodes/list_main/statistics.rst @@ -1,7 +1,8 @@ List Statistics =============== -.. image:: https://user-images.githubusercontent.com/14288520/187531724-31b3ac44-011f-4e0d-a133-bcedaa9a2820.png +.. image:: https://user-images.githubusercontent.com/14288520/187748171-58c72008-67ec-4951-9f69-7f0eb1ab6f96.png + :target: https://user-images.githubusercontent.com/14288520/187748171-58c72008-67ec-4951-9f69-7f0eb1ab6f96.png Functionality ------------- @@ -19,44 +20,44 @@ Parameters The **Function** parameter allows to select the statistical function to compute the corresponding statistical quantity for the input values. -+----------------+----------------------+---------+-------------------------------------------+ -| Param | Type | Default | Description | -+================+======================+=========+===========================================+ -| **Function** | Enum | Average | The statistical function applied to | -| | All Statistics | | the input values. | -| | Selected Statistics | | | -| | | | | -| | Sum | | | -| | Sum Of Squares | | | -| | Sum Of Inverse | | For "All Statistics" selection the node | -| | Product | | computes and outputs the statistical | -| | Average | | quantities for all the statistical | -| | Geometric Mean | | functions along with their corresponding | -| | Harmonic Mean | | names. | -| | Variance | | | -| | Standard Deviation | | | -| | Standard Error | | | -| | Root Mean Square | | For "Selected Statistics" selection the | -| | Skewness | | node computes and outputs the statistical | -| | Kurtosis | | quantities for the selected statistical | -| | Minimum | | functions along with their corresponding | -| | Maximum | | names. | -| | Range | | | -| | Median | | | -| | Percentile | | | -| | Histogram | | | -| | Count | | | -+----------------+----------------------+---------+-------------------------------------------+ -| **Percentage** | Float | 0.75 | The percentage value for the | -| | | | percentile function. [1] | -+----------------+----------------------+---------+-------------------------------------------+ -| **Normalize** | Boolean | False | Flag to normalize the histogram bins | -| | | | to the given normalize size. [2] | -+----------------+----------------------+---------+-------------------------------------------+ -| **Bins** | Int | 10 | The number of bins in the histogram. [2] | -+----------------+----------------------+---------+-------------------------------------------+ -| **Size** | Float | 10.00 | The normalized size of the histogram.[2] | -+----------------+----------------------+---------+-------------------------------------------+ ++----------------+------------------------+---------+-------------------------------------------+ +| Param | Type | Default | Description | ++================+========================+=========+===========================================+ +| **Function** | Enum | Average | The statistical function applied to | +| | * All Statistics | | the input values. | +| | * Selected Statistics | | | +| | | | | +| | * Sum | | | +| | * Sum Of Squares | | | +| | * Sum Of Inverse | | For "All Statistics" selection the node | +| | * Product | | computes and outputs the statistical | +| | * Average | | quantities for all the statistical | +| | * Geometric Mean | | functions along with their corresponding | +| | * Harmonic Mean | | names. | +| | * Variance | | | +| | * Standard Deviation | | | +| | * Standard Error | | | +| | * Root Mean Square | | For "Selected Statistics" selection the | +| | * Skewness | | node computes and outputs the statistical | +| | * Kurtosis | | quantities for the selected statistical | +| | * Minimum | | functions along with their corresponding | +| | * Maximum | | names. | +| | * Range | | | +| | * Median | | | +| | * Percentile | | | +| | * Histogram | | | +| | * Count | | | ++----------------+------------------------+---------+-------------------------------------------+ +| **Percentage** | Float | 0.75 | The percentage value for the | +| | | | percentile function. [1] | ++----------------+------------------------+---------+-------------------------------------------+ +| **Normalize** | Boolean | False | Flag to normalize the histogram bins | +| | | | to the given normalize size. [2] | ++----------------+------------------------+---------+-------------------------------------------+ +| **Bins** | Int | 10 | The number of bins in the histogram. [2] | ++----------------+------------------------+---------+-------------------------------------------+ +| **Size** | Float | 10.00 | The normalized size of the histogram.[2] | ++----------------+------------------------+---------+-------------------------------------------+ Notes: [1] : The **Percentage** input socket is available only for the **Percentile** function. @@ -83,5 +84,14 @@ Examples -------- .. image:: https://user-images.githubusercontent.com/14288520/187533079-ada585a4-d1cf-4eb0-ba80-8faae3f53222.png + :target: https://user-images.githubusercontent.com/14288520/187533079-ada585a4-d1cf-4eb0-ba80-8faae3f53222.png + +* Number-> :doc:`Random ` +* Text-> :doc:`Stethoscope ` + +.. image:: https://user-images.githubusercontent.com/14288520/187532896-f7fe6bdd-d25e-40f4-99bf-d2373f75b9c0.png + :target: https://user-images.githubusercontent.com/14288520/187532896-f7fe6bdd-d25e-40f4-99bf-d2373f75b9c0.png + +* Number-> :doc:`Random ` +* Text-> :doc:`Stethoscope ` -.. image:: https://user-images.githubusercontent.com/14288520/187532896-f7fe6bdd-d25e-40f4-99bf-d2373f75b9c0.png \ No newline at end of file diff --git a/docs/nodes/list_main/sum_mk2.rst b/docs/nodes/list_main/sum_mk2.rst index 3d7e5bad69..d682c9979a 100644 --- a/docs/nodes/list_main/sum_mk2.rst +++ b/docs/nodes/list_main/sum_mk2.rst @@ -2,6 +2,7 @@ List Summa ========== .. image:: https://user-images.githubusercontent.com/14288520/187527049-0d74568c-f3f4-486e-954b-d0a49aeefad9.png + :target: https://user-images.githubusercontent.com/14288520/187527049-0d74568c-f3f4-486e-954b-d0a49aeefad9.png Functionality ------------- @@ -24,5 +25,11 @@ Examples .. image:: https://cloud.githubusercontent.com/assets/5990821/4200340/20740696-3810-11e4-8e2d-8397e801b644.png :alt: ListSummaDemo1.PNG + :target: https://cloud.githubusercontent.com/assets/5990821/4200340/20740696-3810-11e4-8e2d-8397e801b644.png -.. image:: https://user-images.githubusercontent.com/14288520/187526735-b9121369-6803-433c-a2cd-e326c1e64d91.png \ No newline at end of file +.. image:: https://user-images.githubusercontent.com/14288520/187526735-b9121369-6803-433c-a2cd-e326c1e64d91.png + :target: https://user-images.githubusercontent.com/14288520/187526735-b9121369-6803-433c-a2cd-e326c1e64d91.png + +* Number-> :doc:`Number Range ` +* List->List Main-> :doc:`List Join ` +* Text-> :doc:`Stethoscope ` \ No newline at end of file diff --git a/docs/nodes/list_main/zip.rst b/docs/nodes/list_main/zip.rst index bcf6a75f56..a4bb28fca8 100644 --- a/docs/nodes/list_main/zip.rst +++ b/docs/nodes/list_main/zip.rst @@ -2,6 +2,7 @@ List Zip ======== .. image:: https://user-images.githubusercontent.com/14288520/187516998-eb8d150a-ef02-480b-bb8b-739ed20c4049.png + :target: https://user-images.githubusercontent.com/14288520/187516998-eb8d150a-ef02-480b-bb8b-739ed20c4049.png Functionality ------------- @@ -38,5 +39,11 @@ Outputs Examples -------- -.. image:: https://user-images.githubusercontent.com/14288520/187518702-482dd7e7-0b67-46b8-a68c-c8ad60f4111d.png +.. image:: https://user-images.githubusercontent.com/14288520/187518702-482dd7e7-0b67-46b8-a68c-c8ad60f4111d.png + :target: https://user-images.githubusercontent.com/14288520/187518702-482dd7e7-0b67-46b8-a68c-c8ad60f4111d.png +* Number-> :doc:`List Input ` +* List->List Struct-> :doc:`List Levels ` +* Text-> :doc:`Simple Text ` +* Text-> :doc:`String Tools ` +* Text-> :doc:`Stethoscope `