From 9fb6cfb5038e2d3c842815903ffb2996378dfa19 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Sun, 27 Oct 2019 14:00:37 -0700 Subject: [PATCH 01/65] initial commit for PLEP-0007...fill-out summary and abstract --- PLEP-0007.rst | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 PLEP-0007.rst diff --git a/PLEP-0007.rst b/PLEP-0007.rst new file mode 100644 index 0000000..2d2e319 --- /dev/null +++ b/PLEP-0007.rst @@ -0,0 +1,72 @@ +=============================================== +PLEP-0007 – Structure of Top-Level Sub-Packages +=============================================== + ++-------------------+---------------------------------------------+ +| PLEP | 7 | ++===================+=============================================+ +| author(s) | Erik T. Everson | ++-------------------+---------------------------------------------+ +| contact email | eeverson@ucla.edu | ++-------------------+---------------------------------------------+ +| date created | 2019-10-27 | ++-------------------+---------------------------------------------+ +| date last revised | *YYYY-MM-DD* | ++-------------------+---------------------------------------------+ +| type | standard | ++-------------------+---------------------------------------------+ +| status | in preparation | ++-------------------+---------------------------------------------+ +| DOI | | +| | | ++-------------------+---------------------------------------------+ + +Abstract +======== + +This PLEP defines the top-level structure of ``PlasmaPy`` (i.e. +``plasmapy.``). Its intent is to name the top-level +sub-packages and define the type of code they encompass. This +structure should help developers decided where new code should be +placed and keep the top-level namespace from getting bloated. If +new code does NOT fall within the current framework, then this PLEP +needs to be modified/updated accordingly before any new top-level +sub-packages are created. + +Detailed Description +==================== + +*Provide an extended description of the problem and the proposed +changes, including usage examples when needed.* + +Implementation +============== + +*Describe the steps necessary to implement this PLEP, if necessary.* + +Issues, Pull Requests, and Branches +=================================== + +*Provide repository links related to this PLEP, and include +descriptions.* + +Backward Compatibility +====================== + +This PLEP will NOT maintain backward compatibility. + +Alternatives +============ + +*Summarize alternative possibilities to address (or not address) the +problem described in this PLEP, if necessary.* + +Decision Rationale +================== + +*Summarize the discussion on this PLEP and describe the reasoning +behind the decision, if necessary.* + +*Not all PLEPs require all of these sections, and occasionally +additional sections may be necessary. Emphasized text should be +deleted.* From 1382c2ccdbf87acbd14b82f0c9f015b4877fcdb4 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Sun, 27 Oct 2019 14:10:56 -0700 Subject: [PATCH 02/65] start outlining `Detailed Description` --- PLEP-0007.rst | 41 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 2d2e319..80238e2 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -36,8 +36,45 @@ sub-packages are created. Detailed Description ==================== -*Provide an extended description of the problem and the proposed -changes, including usage examples when needed.* +Why? +---- + +By defining a top-level sub-package namespace, developers are better +directed to where code can be added and the ``PlasmaPy`` +**Coordinating Committee** can better manage package bloat. + +Top-Level Sub-Packages +---------------------- + +analysis +~~~~~~~~ + +diagnostics +~~~~~~~~~~~ + +dispersion +~~~~~~~~~~ + +examples +~~~~~~~~ + +formulary +~~~~~~~~~ + +particle +~~~~~~~~ + +plasma +~~~~~~ + +simulations +~~~~~~~~~~~ + +tests +~~~~~ + +utils +~~~~~ Implementation ============== From 80d256c5867ce018fdd67e54574517d8225c2388 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Sun, 27 Oct 2019 14:31:18 -0700 Subject: [PATCH 03/65] testing a table --- PLEP-0007.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 80238e2..4fa9b90 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -49,6 +49,14 @@ Top-Level Sub-Packages analysis ~~~~~~~~ ++------------------------------------------+ +| analysis | ++==========================================+ +| :access: ``plasamapy.analysis`` | +| :scope: | +| blah blah blah | ++------------------------------------------+ + diagnostics ~~~~~~~~~~~ From 94d43366ce0e237019677f82c06b6dc789e513be Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Sun, 27 Oct 2019 14:33:05 -0700 Subject: [PATCH 04/65] testing a table design --- PLEP-0007.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 4fa9b90..e1421af 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -51,11 +51,17 @@ analysis +------------------------------------------+ | analysis | -+==========================================+ ++------------------------------------------+ | :access: ``plasamapy.analysis`` | | :scope: | | blah blah blah | +------------------------------------------+ +| diagnostics | ++------------------------------------------+ +| :access: ``plasamapy.diagnostics`` | +| :scope: | +| blah blah blah | ++------------------------------------------+ diagnostics ~~~~~~~~~~~ From 676c6d9207bb0f2980d1851204c6911fb505c5eb Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Sun, 27 Oct 2019 14:34:55 -0700 Subject: [PATCH 05/65] testing a table design --- PLEP-0007.rst | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index e1421af..86b5216 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -49,19 +49,20 @@ Top-Level Sub-Packages analysis ~~~~~~~~ -+------------------------------------------+ -| analysis | -+------------------------------------------+ -| :access: ``plasamapy.analysis`` | -| :scope: | -| blah blah blah | -+------------------------------------------+ -| diagnostics | -+------------------------------------------+ -| :access: ``plasamapy.diagnostics`` | -| :scope: | -| blah blah blah | -+------------------------------------------+ ++------------------------------------------------------------------------------+ +| **analysis** | ++------------------------------------------------------------------------------+ +| :access: ``plasamapy.analysis`` | +| :scope: | +| blah blah blah | ++------------------------------------------------------------------------------+ +| **diagnostics** | ++------------------------------------------------------------------------------+ +| :access: ``plasamapy.diagnostics`` | +| :scope: | +| blah blah blah | +| blah blah blah | ++------------------------------------------------------------------------------+ diagnostics ~~~~~~~~~~~ From dd1af5b6824406abc770076393f631d0a534bcc8 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Sun, 27 Oct 2019 14:36:41 -0700 Subject: [PATCH 06/65] testing a line blocks in table design --- PLEP-0007.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 86b5216..33d6e0e 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -60,8 +60,8 @@ analysis +------------------------------------------------------------------------------+ | :access: ``plasamapy.diagnostics`` | | :scope: | -| blah blah blah | -| blah blah blah | +| | blah blah blah | +| | blah blah blah | +------------------------------------------------------------------------------+ diagnostics From 5c556001986ee20ec6dfd6cee09cc6b0bc97cb08 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Sun, 27 Oct 2019 14:37:21 -0700 Subject: [PATCH 07/65] testing a line blocks in table design --- PLEP-0007.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 33d6e0e..6a5c929 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -60,8 +60,8 @@ analysis +------------------------------------------------------------------------------+ | :access: ``plasamapy.diagnostics`` | | :scope: | -| | blah blah blah | -| | blah blah blah | +| | blah blah blah | +| | blah blah blah | +------------------------------------------------------------------------------+ diagnostics From ddbc6342c5f8846d9d9cf7e35d5ed24d3f67e228 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Sun, 27 Oct 2019 14:44:18 -0700 Subject: [PATCH 08/65] place all sup-packages into table --- PLEP-0007.rst | 96 +++++++++++++++++++++++++++++++++++---------------- 1 file changed, 66 insertions(+), 30 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 6a5c929..4079f7c 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -46,50 +46,86 @@ directed to where code can be added and the ``PlasmaPy`` Top-Level Sub-Packages ---------------------- -analysis -~~~~~~~~ - +------------------------------------------------------------------------------+ | **analysis** | +------------------------------------------------------------------------------+ +| :directory: ``./plasmapy/analysis/`` | | :access: ``plasamapy.analysis`` | | :scope: | | blah blah blah | +------------------------------------------------------------------------------+ | **diagnostics** | +------------------------------------------------------------------------------+ +| :directory: ``./plasmapy/diagnostics/`` | | :access: ``plasamapy.diagnostics`` | | :scope: | | | blah blah blah | | | blah blah blah | +------------------------------------------------------------------------------+ - -diagnostics -~~~~~~~~~~~ - -dispersion -~~~~~~~~~~ - -examples -~~~~~~~~ - -formulary -~~~~~~~~~ - -particle -~~~~~~~~ - -plasma -~~~~~~ - -simulations -~~~~~~~~~~~ - -tests -~~~~~ - -utils -~~~~~ +| **dispersion** | ++------------------------------------------------------------------------------+ +| :directory: ``./plasmapy/dispersion/`` | +| :access: ``plasamapy.dispersion`` | +| :scope: | +| | blah blah blah | +| | blah blah blah | ++------------------------------------------------------------------------------+ +| **examples** | ++------------------------------------------------------------------------------+ +| :directory: ``./plasmapy/examples/`` | +| :access: ``plasamapy.examples`` | +| :scope: | +| | blah blah blah | +| | blah blah blah | ++------------------------------------------------------------------------------+ +| **formulary** | ++------------------------------------------------------------------------------+ +| :directory: ``./plasmapy/formulary/`` | +| :access: ``plasamapy.formulary`` | +| :scope: | +| | blah blah blah | +| | blah blah blah | ++------------------------------------------------------------------------------+ +| **particle** | ++------------------------------------------------------------------------------+ +| :directory: ``./plasmapy/particle/`` | +| :access: ``plasamapy.particle`` | +| :scope: | +| | blah blah blah | +| | blah blah blah | ++------------------------------------------------------------------------------+ +| **plasma** | ++------------------------------------------------------------------------------+ +| :directory: ``./plasmapy/plasma/`` | +| :access: ``plasamapy.plasma`` | +| :scope: | +| | blah blah blah | +| | blah blah blah | ++------------------------------------------------------------------------------+ +| **simulations** | ++------------------------------------------------------------------------------+ +| :directory: ``./plasmapy/simulations/`` | +| :access: ``plasamapy.simulations`` | +| :scope: | +| | blah blah blah | +| | blah blah blah | ++------------------------------------------------------------------------------+ +| **tests** | ++------------------------------------------------------------------------------+ +| :directory: ``./plasmapy/tests/`` | +| :access: ``plasamapy.tests`` | +| :scope: | +| | blah blah blah | +| | blah blah blah | ++------------------------------------------------------------------------------+ +| **utils** | ++------------------------------------------------------------------------------+ +| :directory: ``./plasmapy/utils/`` | +| :access: ``plasamapy.utils`` | +| :scope: | +| | blah blah blah | +| | blah blah blah | ++------------------------------------------------------------------------------+ Implementation ============== From a501334665854e6f0aaa252c40943e413c68fef8 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Mon, 28 Oct 2019 18:07:11 -0700 Subject: [PATCH 09/65] add Tulasi Parashar, Steve Vincena, and Nick Murphy to authors --- PLEP-0007.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 4079f7c..b0aff31 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -5,7 +5,8 @@ PLEP-0007 – Structure of Top-Level Sub-Packages +-------------------+---------------------------------------------+ | PLEP | 7 | +===================+=============================================+ -| author(s) | Erik T. Everson | +| author(s) | Erik T. Everson, Tulasi Parashar, | +| | Steve Vincena, Nicholas A. Murphy | +-------------------+---------------------------------------------+ | contact email | eeverson@ucla.edu | +-------------------+---------------------------------------------+ From 637ba4e990ed8870357d0b20cd3a8df18842c88c Mon Sep 17 00:00:00 2001 From: Nick Murphy Date: Mon, 28 Oct 2019 18:21:02 -0700 Subject: [PATCH 10/65] defining scope of `plasmapy.utils` --- PLEP-0007.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index b0aff31..2ae80ec 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -124,8 +124,10 @@ Top-Level Sub-Packages | :directory: ``./plasmapy/utils/`` | | :access: ``plasamapy.utils`` | | :scope: | -| | blah blah blah | -| | blah blah blah | +| * A collection of "utility" functions and classes to help us write | +| (what we try to think of as) clean, readable, and informative code. | +| * This collection does not provide any physics tools, instead it is | +| focused on providing package development tools. | +------------------------------------------------------------------------------+ Implementation From 930e0fc43c2977a5a0cdc179231a1e8edfe0e728 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Mon, 28 Oct 2019 18:24:37 -0700 Subject: [PATCH 11/65] defining scope of `plasmapy.tests` --- PLEP-0007.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 2ae80ec..0feec97 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -116,8 +116,8 @@ Top-Level Sub-Packages | :directory: ``./plasmapy/tests/`` | | :access: ``plasamapy.tests`` | | :scope: | -| | blah blah blah | -| | blah blah blah | +| * A collection of tests for top-level modules (i.e. functions and classes | +| defined in top-level `.py` files). | +------------------------------------------------------------------------------+ | **utils** | +------------------------------------------------------------------------------+ From 2855a77504a20512d6e8f926febf58ce29eaa8bc Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Mon, 28 Oct 2019 18:37:05 -0700 Subject: [PATCH 12/65] defining scope of `plasmapy.simulations` --- PLEP-0007.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 0feec97..2e3991e 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -108,8 +108,12 @@ Top-Level Sub-Packages | :directory: ``./plasmapy/simulations/`` | | :access: ``plasamapy.simulations`` | | :scope: | -| | blah blah blah | -| | blah blah blah | +| * A collection of functions, classes, and sub-packages focused on | +| interfacing with simulations and/or running simulations. | +| * If a new feature falls under the scope of the `analysis` and/or | +| `diagnostics` sub-packages, then the feature should be included one of | +| respective packages. For example, a synthetic diagnostic should be | +| included in the `plasmapy.diagnotics` sub-package. | +------------------------------------------------------------------------------+ | **tests** | +------------------------------------------------------------------------------+ From 9d084ad36af337fcbc46f640cd4753541b570453 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Mon, 28 Oct 2019 18:38:06 -0700 Subject: [PATCH 13/65] testing :additional PLEP: look --- PLEP-0007.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 2e3991e..0550f62 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -54,11 +54,13 @@ Top-Level Sub-Packages | :access: ``plasamapy.analysis`` | | :scope: | | blah blah blah | +| :additional PLEP: | +------------------------------------------------------------------------------+ | **diagnostics** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/diagnostics/`` | | :access: ``plasamapy.diagnostics`` | +| :additional PLEP: | | :scope: | | | blah blah blah | | | blah blah blah | From d3b3d80de6f6d8b723b1a31c9da2a945d722ea98 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Mon, 28 Oct 2019 18:44:27 -0700 Subject: [PATCH 14/65] add to abstract...this PLEP only defines the general scope of top-level packages, details are left to package focused PLEPs --- PLEP-0007.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 0550f62..106d46c 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -27,7 +27,9 @@ Abstract This PLEP defines the top-level structure of ``PlasmaPy`` (i.e. ``plasmapy.``). Its intent is to name the top-level -sub-packages and define the type of code they encompass. This +sub-packages and define the general scope of code they encompass. +Sub-package details are left to be finely defined in package focused +PLEPs, which should NOT conflict with this PLEP. This structure should help developers decided where new code should be placed and keep the top-level namespace from getting bloated. If new code does NOT fall within the current framework, then this PLEP @@ -52,15 +54,15 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/analysis/`` | | :access: ``plasamapy.analysis`` | +| :sub-package PLEP: | | :scope: | | blah blah blah | -| :additional PLEP: | +------------------------------------------------------------------------------+ | **diagnostics** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/diagnostics/`` | | :access: ``plasamapy.diagnostics`` | -| :additional PLEP: | +| :sub-package PLEP: | | :scope: | | | blah blah blah | | | blah blah blah | From c6265c13311ff598b6ba1fd66387df8852940cfe Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Mon, 28 Oct 2019 18:59:42 -0700 Subject: [PATCH 15/65] add :sub-package PLEP: entry to each sub-package --- PLEP-0007.rst | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 106d46c..29d351d 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -27,9 +27,9 @@ Abstract This PLEP defines the top-level structure of ``PlasmaPy`` (i.e. ``plasmapy.``). Its intent is to name the top-level -sub-packages and define the general scope of code they encompass. -Sub-package details are left to be finely defined in package focused -PLEPs, which should NOT conflict with this PLEP. This +sub-packages and define the general scope of the code they encompass. +Sub-package details are left to be defined in package focused +PLEPs, which should *NOT* conflict with this PLEP. This structure should help developers decided where new code should be placed and keep the top-level namespace from getting bloated. If new code does NOT fall within the current framework, then this PLEP @@ -71,6 +71,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/dispersion/`` | | :access: ``plasamapy.dispersion`` | +| :sub-package PLEP: | | :scope: | | | blah blah blah | | | blah blah blah | @@ -79,6 +80,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/examples/`` | | :access: ``plasamapy.examples`` | +| :sub-package PLEP: | | :scope: | | | blah blah blah | | | blah blah blah | @@ -87,6 +89,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/formulary/`` | | :access: ``plasamapy.formulary`` | +| :sub-package PLEP: | | :scope: | | | blah blah blah | | | blah blah blah | @@ -95,6 +98,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/particle/`` | | :access: ``plasamapy.particle`` | +| :sub-package PLEP: | | :scope: | | | blah blah blah | | | blah blah blah | @@ -103,6 +107,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/plasma/`` | | :access: ``plasamapy.plasma`` | +| :sub-package PLEP: | | :scope: | | | blah blah blah | | | blah blah blah | @@ -111,6 +116,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/simulations/`` | | :access: ``plasamapy.simulations`` | +| :sub-package PLEP: | | :scope: | | * A collection of functions, classes, and sub-packages focused on | | interfacing with simulations and/or running simulations. | @@ -118,11 +124,20 @@ Top-Level Sub-Packages | `diagnostics` sub-packages, then the feature should be included one of | | respective packages. For example, a synthetic diagnostic should be | | included in the `plasmapy.diagnotics` sub-package. | +| | +| A collection of functions, classes, and sub-packages focused on | +| interfacing with simulations and/or running simulations. | +| | +| If a new feature falls under the scope of the `analysis` and/or | +| `diagnostics` sub-packages, then the feature should be included one of | +| respective packages. For example, a synthetic diagnostic should be | +| included in the `plasmapy.diagnotics` sub-package. | +------------------------------------------------------------------------------+ | **tests** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/tests/`` | | :access: ``plasamapy.tests`` | +| :sub-package PLEP: | | :scope: | | * A collection of tests for top-level modules (i.e. functions and classes | | defined in top-level `.py` files). | @@ -131,6 +146,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/utils/`` | | :access: ``plasamapy.utils`` | +| :sub-package PLEP: | | :scope: | | * A collection of "utility" functions and classes to help us write | | (what we try to think of as) clean, readable, and informative code. | From 32d3681ed4ad1c8c852fc3ce5afa67ab6a66f2f6 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Mon, 28 Oct 2019 19:01:07 -0700 Subject: [PATCH 16/65] remove bullet point list --- PLEP-0007.rst | 7 ------- 1 file changed, 7 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 29d351d..e020403 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -118,13 +118,6 @@ Top-Level Sub-Packages | :access: ``plasamapy.simulations`` | | :sub-package PLEP: | | :scope: | -| * A collection of functions, classes, and sub-packages focused on | -| interfacing with simulations and/or running simulations. | -| * If a new feature falls under the scope of the `analysis` and/or | -| `diagnostics` sub-packages, then the feature should be included one of | -| respective packages. For example, a synthetic diagnostic should be | -| included in the `plasmapy.diagnotics` sub-package. | -| | | A collection of functions, classes, and sub-packages focused on | | interfacing with simulations and/or running simulations. | | | From 5a15ce468e7baf28a2492c05bc8ccedeb109c1f0 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Mon, 28 Oct 2019 19:31:55 -0700 Subject: [PATCH 17/65] defining scope of `plasmapy.formulary` --- PLEP-0007.rst | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index e020403..f7ff634 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -91,8 +91,9 @@ Top-Level Sub-Packages | :access: ``plasamapy.formulary`` | | :sub-package PLEP: | | :scope: | -| | blah blah blah | -| | blah blah blah | +| A collection of functions, classes, and sub-packages that provide | +| mathematical and scientific formulas for calculating physical parameters | +| of various plasmas. +------------------------------------------------------------------------------+ | **particle** | +------------------------------------------------------------------------------+ @@ -132,8 +133,8 @@ Top-Level Sub-Packages | :access: ``plasamapy.tests`` | | :sub-package PLEP: | | :scope: | -| * A collection of tests for top-level modules (i.e. functions and classes | -| defined in top-level `.py` files). | +| A collection of tests for top-level modules (i.e. functions and classes | +| defined in top-level `.py` files). | +------------------------------------------------------------------------------+ | **utils** | +------------------------------------------------------------------------------+ @@ -141,10 +142,11 @@ Top-Level Sub-Packages | :access: ``plasamapy.utils`` | | :sub-package PLEP: | | :scope: | -| * A collection of "utility" functions and classes to help us write | -| (what we try to think of as) clean, readable, and informative code. | -| * This collection does not provide any physics tools, instead it is | -| focused on providing package development tools. | +| A collection of "utility" functions and classes to help us write | +| (what we try to think of as) clean, readable, and informative code. | +| | +| This collection does not provide any physics tools, instead it is | +| focused on providing package development tools. | +------------------------------------------------------------------------------+ Implementation From ada2eeb5fbbf5d7c2ca92f6b129fda0f78b61bbd Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Mon, 28 Oct 2019 19:51:36 -0700 Subject: [PATCH 18/65] defining scope of `plasmapy.analysis` --- PLEP-0007.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index f7ff634..c0aefd2 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -56,7 +56,13 @@ Top-Level Sub-Packages | :access: ``plasamapy.analysis`` | | :sub-package PLEP: | | :scope: | -| blah blah blah | +| A collection of functions, classes, and sub-packages focused on providing | +| analysis techniques that can be applied to data collected from a variety | +| of sources (simulation, experimental, space, etc.). | +| | +| The focus of an analysis routine should be made as broad as possible. | +| When the routine's functionality becomes highly-tailor to its application, | +| then it should be placed into an appropriate explicit namespace. | +------------------------------------------------------------------------------+ | **diagnostics** | +------------------------------------------------------------------------------+ @@ -93,7 +99,7 @@ Top-Level Sub-Packages | :scope: | | A collection of functions, classes, and sub-packages that provide | | mathematical and scientific formulas for calculating physical parameters | -| of various plasmas. +| of various plasmas. | +------------------------------------------------------------------------------+ | **particle** | +------------------------------------------------------------------------------+ From a0389c760623226eced4fe4eb2007574dcc513cb Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Mon, 28 Oct 2019 19:54:57 -0700 Subject: [PATCH 19/65] add `` to get proper inline code typesetting --- PLEP-0007.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index c0aefd2..3bb45ea 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -128,10 +128,10 @@ Top-Level Sub-Packages | A collection of functions, classes, and sub-packages focused on | | interfacing with simulations and/or running simulations. | | | -| If a new feature falls under the scope of the `analysis` and/or | -| `diagnostics` sub-packages, then the feature should be included one of | +| If a new feature falls under the scope of the ``analysis`` and/or | +| ``diagnostics`` sub-packages, then the feature should be included one of | | respective packages. For example, a synthetic diagnostic should be | -| included in the `plasmapy.diagnotics` sub-package. | +| included in the ``plasmapy.diagnotics`` sub-package. | +------------------------------------------------------------------------------+ | **tests** | +------------------------------------------------------------------------------+ @@ -140,7 +140,7 @@ Top-Level Sub-Packages | :sub-package PLEP: | | :scope: | | A collection of tests for top-level modules (i.e. functions and classes | -| defined in top-level `.py` files). | +| defined in top-level ``.py`` files). | +------------------------------------------------------------------------------+ | **utils** | +------------------------------------------------------------------------------+ From 2aa0677c6c3bb4c9a2a7fc3706600b816c5fe28b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Sta=C5=84czak?= Date: Tue, 29 Oct 2019 05:38:10 +0100 Subject: [PATCH 20/65] Fix a few typos I assumed you didn't actually want to change `plasmapy.simulation` to `plasmapy.simulations` plural, so I reverted that. --- PLEP-0007.rst | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 3bb45ea..0e63897 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -53,7 +53,7 @@ Top-Level Sub-Packages | **analysis** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/analysis/`` | -| :access: ``plasamapy.analysis`` | +| :access: ``plasmapy.analysis`` | | :sub-package PLEP: | | :scope: | | A collection of functions, classes, and sub-packages focused on providing | @@ -61,13 +61,14 @@ Top-Level Sub-Packages | of sources (simulation, experimental, space, etc.). | | | | The focus of an analysis routine should be made as broad as possible. | -| When the routine's functionality becomes highly-tailor to its application, | -| then it should be placed into an appropriate explicit namespace. | +| When the routine's functionality becomes highly-tailored to its | +| application, then it should be placed into an appropriate explicit | +| namespace. | +------------------------------------------------------------------------------+ | **diagnostics** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/diagnostics/`` | -| :access: ``plasamapy.diagnostics`` | +| :access: ``plasmapy.diagnostics`` | | :sub-package PLEP: | | :scope: | | | blah blah blah | @@ -76,7 +77,7 @@ Top-Level Sub-Packages | **dispersion** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/dispersion/`` | -| :access: ``plasamapy.dispersion`` | +| :access: ``plasmapy.dispersion`` | | :sub-package PLEP: | | :scope: | | | blah blah blah | @@ -85,7 +86,7 @@ Top-Level Sub-Packages | **examples** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/examples/`` | -| :access: ``plasamapy.examples`` | +| :access: ``plasmapy.examples`` | | :sub-package PLEP: | | :scope: | | | blah blah blah | @@ -94,7 +95,7 @@ Top-Level Sub-Packages | **formulary** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/formulary/`` | -| :access: ``plasamapy.formulary`` | +| :access: ``plasmapy.formulary`` | | :sub-package PLEP: | | :scope: | | A collection of functions, classes, and sub-packages that provide | @@ -104,7 +105,7 @@ Top-Level Sub-Packages | **particle** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/particle/`` | -| :access: ``plasamapy.particle`` | +| :access: ``plasmapy.particle`` | | :sub-package PLEP: | | :scope: | | | blah blah blah | @@ -113,16 +114,16 @@ Top-Level Sub-Packages | **plasma** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/plasma/`` | -| :access: ``plasamapy.plasma`` | +| :access: ``plasmapy.plasma`` | | :sub-package PLEP: | | :scope: | | | blah blah blah | | | blah blah blah | +------------------------------------------------------------------------------+ -| **simulations** | +| **simulation** | +------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/simulations/`` | -| :access: ``plasamapy.simulations`` | +| :directory: ``./plasmapy/simulation/`` | +| :access: ``plasmapy.simulation`` | | :sub-package PLEP: | | :scope: | | A collection of functions, classes, and sub-packages focused on | @@ -131,12 +132,12 @@ Top-Level Sub-Packages | If a new feature falls under the scope of the ``analysis`` and/or | | ``diagnostics`` sub-packages, then the feature should be included one of | | respective packages. For example, a synthetic diagnostic should be | -| included in the ``plasmapy.diagnotics`` sub-package. | +| included in the ``plasmapy.diagnostics`` sub-package. | +------------------------------------------------------------------------------+ | **tests** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/tests/`` | -| :access: ``plasamapy.tests`` | +| :access: ``plasmapy.tests`` | | :sub-package PLEP: | | :scope: | | A collection of tests for top-level modules (i.e. functions and classes | @@ -145,7 +146,7 @@ Top-Level Sub-Packages | **utils** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/utils/`` | -| :access: ``plasamapy.utils`` | +| :access: ``plasmapy.utils`` | | :sub-package PLEP: | | :scope: | | A collection of "utility" functions and classes to help us write | From 792292ab47da52fc7fb0b6da180adcf7d79234e1 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Tue, 29 Oct 2019 09:19:23 -0700 Subject: [PATCH 21/65] add scope to `plasmapy.particle` --- PLEP-0007.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 3bb45ea..11e2326 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -107,8 +107,14 @@ Top-Level Sub-Packages | :access: ``plasamapy.particle`` | | :sub-package PLEP: | | :scope: | -| | blah blah blah | -| | blah blah blah | +| A collection of functions, classes, and sub-packages that fully defines | +| the properties of a "particle." A "particle" can come in many forms | +| ranging from a traditional particle (electron, ion, atom, etc.) to more | +| exotic types like dust particles, dimensionless particles for simulations, | +| super-particles for simulations, etc. | +| | +| All types of particles in this sub-package should be able to be | +| instantiated through a particle factory class, `Particle`. | +------------------------------------------------------------------------------+ | **plasma** | +------------------------------------------------------------------------------+ From 0bf60bae2f35b000a2063e0a588745311706ded7 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Tue, 29 Oct 2019 09:29:00 -0700 Subject: [PATCH 22/65] add scope to `plasmapy.dispersion` --- PLEP-0007.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 97caccb..cc16e4f 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -80,8 +80,11 @@ Top-Level Sub-Packages | :access: ``plasmapy.dispersion`` | | :sub-package PLEP: | | :scope: | -| | blah blah blah | -| | blah blah blah | +| A collection of functions, classes, and sub-packages dedicated to solving | +| various plasma dispersion relations. | +| | +| All dispersion solvers defined in this sub-package should be accessible | +| through a dispersion solver factory class, ``DispersionSolver``. | +------------------------------------------------------------------------------+ | **examples** | +------------------------------------------------------------------------------+ @@ -115,7 +118,7 @@ Top-Level Sub-Packages | super-particles for simulations, etc. | | | | All types of particles in this sub-package should be able to be | -| instantiated through a particle factory class, `Particle`. | +| instantiated through a particle factory class, ``Particle``. | +------------------------------------------------------------------------------+ | **plasma** | +------------------------------------------------------------------------------+ From 37332a894659d1cd96efeccb02c04503300542b3 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Tue, 29 Oct 2019 10:12:41 -0700 Subject: [PATCH 23/65] add scope to `plasmapy.diagnostics` --- PLEP-0007.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index cc16e4f..b15bdda 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -71,8 +71,18 @@ Top-Level Sub-Packages | :access: ``plasmapy.diagnostics`` | | :sub-package PLEP: | | :scope: | -| | blah blah blah | -| | blah blah blah | +| A collection of functions, classes, and sub-packages that fully defines | +| the parameters of a "diagnostic." A "diagnostic" is any data collecting | +| instrument ranging from experimental probes, like Langmuir and magnetic | +| flux probes, to analogous synthetic diagnostics for simulations. | +| | +| Tools in this package do not define any analysis routines, but focus on | +| defining probe characteristics/calibrations that can be seamlessly passed | +| to ``plasmapy.analysis`` routines. | +| | +| A ``Diagnostic`` class should fully define its diagnostic characteristics | +| and provide access to its most relevant analysis tools found in | +| ``plasmapy.analysis``. | +------------------------------------------------------------------------------+ | **dispersion** | +------------------------------------------------------------------------------+ From a6bf2d360f693d9b0c61080c1a596a685c9c3012 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Tue, 29 Oct 2019 10:15:55 -0700 Subject: [PATCH 24/65] replaced :sub-package PLEP: with just :PLEP: ...the flag/key is already in the sub-package focused table --- PLEP-0007.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index b15bdda..7050c31 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -54,7 +54,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/analysis/`` | | :access: ``plasmapy.analysis`` | -| :sub-package PLEP: | +| :PLEP: | | :scope: | | A collection of functions, classes, and sub-packages focused on providing | | analysis techniques that can be applied to data collected from a variety | @@ -69,7 +69,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/diagnostics/`` | | :access: ``plasmapy.diagnostics`` | -| :sub-package PLEP: | +| :PLEP: | | :scope: | | A collection of functions, classes, and sub-packages that fully defines | | the parameters of a "diagnostic." A "diagnostic" is any data collecting | @@ -88,7 +88,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/dispersion/`` | | :access: ``plasmapy.dispersion`` | -| :sub-package PLEP: | +| :PLEP: | | :scope: | | A collection of functions, classes, and sub-packages dedicated to solving | | various plasma dispersion relations. | @@ -100,7 +100,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/examples/`` | | :access: ``plasmapy.examples`` | -| :sub-package PLEP: | +| :PLEP: | | :scope: | | | blah blah blah | | | blah blah blah | @@ -109,7 +109,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/formulary/`` | | :access: ``plasmapy.formulary`` | -| :sub-package PLEP: | +| :PLEP: | | :scope: | | A collection of functions, classes, and sub-packages that provide | | mathematical and scientific formulas for calculating physical parameters | @@ -119,7 +119,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/particle/`` | | :access: ``plasmapy.particle`` | -| :sub-package PLEP: | +| :PLEP: | | :scope: | | A collection of functions, classes, and sub-packages that fully defines | | the properties of a "particle." A "particle" can come in many forms | @@ -134,7 +134,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/plasma/`` | | :access: ``plasmapy.plasma`` | -| :sub-package PLEP: | +| :PLEP: | | :scope: | | | blah blah blah | | | blah blah blah | @@ -143,7 +143,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/simulation/`` | | :access: ``plasmapy.simulation`` | -| :sub-package PLEP: | +| :PLEP: | | :scope: | | A collection of functions, classes, and sub-packages focused on | | interfacing with simulations and/or running simulations. | @@ -157,7 +157,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/tests/`` | | :access: ``plasmapy.tests`` | -| :sub-package PLEP: | +| :PLEP: | | :scope: | | A collection of tests for top-level modules (i.e. functions and classes | | defined in top-level ``.py`` files). | @@ -166,7 +166,7 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/utils/`` | | :access: ``plasmapy.utils`` | -| :sub-package PLEP: | +| :PLEP: | | :scope: | | A collection of "utility" functions and classes to help us write | | (what we try to think of as) clean, readable, and informative code. | From 7d34ff60ab51b50008a34dd81283be82e3d50cba Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Tue, 29 Oct 2019 10:31:35 -0700 Subject: [PATCH 25/65] add scope for `plasmapy.plasma` --- PLEP-0007.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 7050c31..38c7c1b 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -136,8 +136,12 @@ Top-Level Sub-Packages | :access: ``plasmapy.plasma`` | | :PLEP: | | :scope: | -| | blah blah blah | -| | blah blah blah | +| A collection of functions, classes, and sub-packages that fully defines a | +| plasma. This would include the plasma's species constituents and physical | +| parameters (like temperature, boundary conditions, magnetic fields, etc.). | +| | +| Any tools that go into defining a plasma or its environment (e.g. a field | +| solver) should be included in a sub-package withing ``plasmapy.plasma``. | +------------------------------------------------------------------------------+ | **simulation** | +------------------------------------------------------------------------------+ From 4eede0f7cb17bba04649e42008d63d06c9644041 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Tue, 29 Oct 2019 10:54:55 -0700 Subject: [PATCH 26/65] add scope for `plasmapy.examples` --- PLEP-0007.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 38c7c1b..6e588d9 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -102,8 +102,8 @@ Top-Level Sub-Packages | :access: ``plasmapy.examples`` | | :PLEP: | | :scope: | -| | blah blah blah | -| | blah blah blah | +| A collection of routines showing how to use and/or interface with the | +| various PlasmaPy tools. | +------------------------------------------------------------------------------+ | **formulary** | +------------------------------------------------------------------------------+ From b0cb96d40193c1525f2ca0cd9db22e8ec79ab999 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Tue, 29 Oct 2019 17:00:27 -0700 Subject: [PATCH 27/65] remove `plasmapy.examples`, pluralize `plasmapy.particles` --- PLEP-0007.rst | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 6e588d9..66c099e 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -96,15 +96,6 @@ Top-Level Sub-Packages | All dispersion solvers defined in this sub-package should be accessible | | through a dispersion solver factory class, ``DispersionSolver``. | +------------------------------------------------------------------------------+ -| **examples** | -+------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/examples/`` | -| :access: ``plasmapy.examples`` | -| :PLEP: | -| :scope: | -| A collection of routines showing how to use and/or interface with the | -| various PlasmaPy tools. | -+------------------------------------------------------------------------------+ | **formulary** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/formulary/`` | @@ -115,10 +106,10 @@ Top-Level Sub-Packages | mathematical and scientific formulas for calculating physical parameters | | of various plasmas. | +------------------------------------------------------------------------------+ -| **particle** | +| **particles** | +------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/particle/`` | -| :access: ``plasmapy.particle`` | +| :directory: ``./plasmapy/particles/`` | +| :access: ``plasmapy.particles`` | | :PLEP: | | :scope: | | A collection of functions, classes, and sub-packages that fully defines | @@ -179,6 +170,18 @@ Top-Level Sub-Packages | focused on providing package development tools. | +------------------------------------------------------------------------------+ +.. + +------------------------------------------------------------------------------+ + | **examples** | + +------------------------------------------------------------------------------+ + | :directory: ``./plasmapy/examples/`` | + | :access: ``plasmapy.examples`` | + | :PLEP: | + | :scope: | + | A collection of routines showing how to use and/or interface with the | + | various PlasmaPy tools. | + +------------------------------------------------------------------------------+ + Implementation ============== From 617fd8e56259dfa372efd6bd417b3860ec69865f Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Tue, 29 Oct 2019 17:04:47 -0700 Subject: [PATCH 28/65] fix table --- PLEP-0007.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 66c099e..49d8dfa 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -108,8 +108,8 @@ Top-Level Sub-Packages +------------------------------------------------------------------------------+ | **particles** | +------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/particles/`` | -| :access: ``plasmapy.particles`` | +| :directory: ``./plasmapy/particles/`` | +| :access: ``plasmapy.particles`` | | :PLEP: | | :scope: | | A collection of functions, classes, and sub-packages that fully defines | @@ -170,8 +170,7 @@ Top-Level Sub-Packages | focused on providing package development tools. | +------------------------------------------------------------------------------+ -.. - +------------------------------------------------------------------------------+ +.. +------------------------------------------------------------------------------+ | **examples** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/examples/`` | From ba24722c0fa58430d5b4edc4f6a77ada418b5664 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Tue, 29 Oct 2019 17:13:53 -0700 Subject: [PATCH 29/65] trying to link to table row --- PLEP-0007.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 49d8dfa..9f57112 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -49,7 +49,10 @@ directed to where code can be added and the ``PlasmaPy`` Top-Level Sub-Packages ---------------------- +* `analysis`_ + +------------------------------------------------------------------------------+ +| .. _analysis: | | **analysis** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/analysis/`` | From 68ebe7126e8bfdef0f086bffc230fa9a85855b38 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Tue, 29 Oct 2019 17:16:36 -0700 Subject: [PATCH 30/65] still trying to hyperlink table --- PLEP-0007.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 9f57112..0cd3288 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -49,10 +49,12 @@ directed to where code can be added and the ``PlasmaPy`` Top-Level Sub-Packages ---------------------- -* `analysis`_ +#. `analysis`_ +#. `diagnostics`_ +------------------------------------------------------------------------------+ | .. _analysis: | +| | | **analysis** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/analysis/`` | @@ -68,6 +70,8 @@ Top-Level Sub-Packages | application, then it should be placed into an appropriate explicit | | namespace. | +------------------------------------------------------------------------------+ +| .. _diagnostics: | +| | | **diagnostics** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/diagnostics/`` | From 280897d4e6bf9d0e77de8887257d41b441f2d261 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Tue, 29 Oct 2019 17:20:28 -0700 Subject: [PATCH 31/65] add links to all sub-package descriptions in the table --- PLEP-0007.rst | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 0cd3288..6a192a7 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -51,6 +51,13 @@ Top-Level Sub-Packages #. `analysis`_ #. `diagnostics`_ +#. `dispersion`_ +#. `formulary`_ +#. `particles`_ +#. `plasma`_ +#. `simulation`_ +#. `tests`_ +#. `utils`_ +------------------------------------------------------------------------------+ | .. _analysis: | @@ -70,7 +77,7 @@ Top-Level Sub-Packages | application, then it should be placed into an appropriate explicit | | namespace. | +------------------------------------------------------------------------------+ -| .. _diagnostics: | +| .. _diagnostics: | | | | **diagnostics** | +------------------------------------------------------------------------------+ @@ -91,6 +98,8 @@ Top-Level Sub-Packages | and provide access to its most relevant analysis tools found in | | ``plasmapy.analysis``. | +------------------------------------------------------------------------------+ +| .. _dispersion: | +| | | **dispersion** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/dispersion/`` | @@ -103,6 +112,8 @@ Top-Level Sub-Packages | All dispersion solvers defined in this sub-package should be accessible | | through a dispersion solver factory class, ``DispersionSolver``. | +------------------------------------------------------------------------------+ +| .. _formulary: | +| | | **formulary** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/formulary/`` | @@ -113,6 +124,8 @@ Top-Level Sub-Packages | mathematical and scientific formulas for calculating physical parameters | | of various plasmas. | +------------------------------------------------------------------------------+ +| .. _particles: | +| | | **particles** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/particles/`` | @@ -128,6 +141,8 @@ Top-Level Sub-Packages | All types of particles in this sub-package should be able to be | | instantiated through a particle factory class, ``Particle``. | +------------------------------------------------------------------------------+ +| .. _plasma: | +| | | **plasma** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/plasma/`` | @@ -141,6 +156,8 @@ Top-Level Sub-Packages | Any tools that go into defining a plasma or its environment (e.g. a field | | solver) should be included in a sub-package withing ``plasmapy.plasma``. | +------------------------------------------------------------------------------+ +| .. _simulation: | +| | | **simulation** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/simulation/`` | @@ -155,6 +172,8 @@ Top-Level Sub-Packages | respective packages. For example, a synthetic diagnostic should be | | included in the ``plasmapy.diagnostics`` sub-package. | +------------------------------------------------------------------------------+ +| .. _tests: | +| | | **tests** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/tests/`` | @@ -164,6 +183,8 @@ Top-Level Sub-Packages | A collection of tests for top-level modules (i.e. functions and classes | | defined in top-level ``.py`` files). | +------------------------------------------------------------------------------+ +| .. _utils: | +| | | **utils** | +------------------------------------------------------------------------------+ | :directory: ``./plasmapy/utils/`` | From d68cc4de71a0601741cf34bc3669667ea0588883 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Tue, 29 Oct 2019 17:23:07 -0700 Subject: [PATCH 32/65] pluralize sub-package plasmapy.plasmas --- PLEP-0007.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 6a192a7..14513ae 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -54,7 +54,7 @@ Top-Level Sub-Packages #. `dispersion`_ #. `formulary`_ #. `particles`_ -#. `plasma`_ +#. `plasmas`_ #. `simulation`_ #. `tests`_ #. `utils`_ @@ -141,12 +141,12 @@ Top-Level Sub-Packages | All types of particles in this sub-package should be able to be | | instantiated through a particle factory class, ``Particle``. | +------------------------------------------------------------------------------+ -| .. _plasma: | +| .. _plasmas: | | | -| **plasma** | +| **plasmas** | +------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/plasma/`` | -| :access: ``plasmapy.plasma`` | +| :directory: ``./plasmapy/plasmas/`` | +| :access: ``plasmapy.plasmas`` | | :PLEP: | | :scope: | | A collection of functions, classes, and sub-packages that fully defines a | @@ -154,7 +154,7 @@ Top-Level Sub-Packages | parameters (like temperature, boundary conditions, magnetic fields, etc.). | | | | Any tools that go into defining a plasma or its environment (e.g. a field | -| solver) should be included in a sub-package withing ``plasmapy.plasma``. | +| solver) should be included in a sub-package withing ``plasmapy.plasmas``. | +------------------------------------------------------------------------------+ | .. _simulation: | | | From e6e3c56019e712e85652de1b9be30e3efa86f5e9 Mon Sep 17 00:00:00 2001 From: rocco8773 Date: Tue, 19 Nov 2019 10:22:29 -0800 Subject: [PATCH 33/65] singular-ize sub-package plasmapy.plasmas -> plasmapy.plasma --- PLEP-0007.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 14513ae..fea06e8 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -54,7 +54,7 @@ Top-Level Sub-Packages #. `dispersion`_ #. `formulary`_ #. `particles`_ -#. `plasmas`_ +#. `plasma`_ #. `simulation`_ #. `tests`_ #. `utils`_ @@ -141,12 +141,12 @@ Top-Level Sub-Packages | All types of particles in this sub-package should be able to be | | instantiated through a particle factory class, ``Particle``. | +------------------------------------------------------------------------------+ -| .. _plasmas: | +| .. _plasma: | | | -| **plasmas** | +| **plasma** | +------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/plasmas/`` | -| :access: ``plasmapy.plasmas`` | +| :directory: ``./plasmapy/plasma/`` | +| :access: ``plasmapy.plasma`` | | :PLEP: | | :scope: | | A collection of functions, classes, and sub-packages that fully defines a | @@ -154,7 +154,7 @@ Top-Level Sub-Packages | parameters (like temperature, boundary conditions, magnetic fields, etc.). | | | | Any tools that go into defining a plasma or its environment (e.g. a field | -| solver) should be included in a sub-package withing ``plasmapy.plasmas``. | +| solver) should be included in a sub-package withing ``plasmapy.plasma``. | +------------------------------------------------------------------------------+ | .. _simulation: | | | From f2e5cf53d9115aeee2ab57305ed64406dfc37d5f Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Tue, 28 Jan 2020 11:18:20 -0800 Subject: [PATCH 34/65] outline addons subpackage --- PLEP-0007.rst | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index fea06e8..d0dd583 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -49,6 +49,7 @@ directed to where code can be added and the ``PlasmaPy`` Top-Level Sub-Packages ---------------------- +#. `addons`_ #. `analysis`_ #. `diagnostics`_ #. `dispersion`_ @@ -59,6 +60,29 @@ Top-Level Sub-Packages #. `tests`_ #. `utils`_ +.. _`native namespace package`: https://packaging.python.org/guides/packaging-namespace-packages/#native-namespace-packages +.. _`PEP 420`: https://www.python.org/dev/peps/pep-0420/ + ++------------------------------------------------------------------------------+ +| .. _addons: | +| | +| **addons** | ++------------------------------------------------------------------------------+ +| :directory: ``./plasmapy/addons/`` | +| :access: ``plasmapy.addons`` | +| :PLEP: | +| :scope: | +| The ``addons`` sub-package is a `native namespace package`_ setup | +| in accordance with the `PEP 420`_ guidelines. | +| | +| A collection of functions, classes, and sub-packages focused on providing | +| analysis techniques that can be applied to data collected from a variety | +| of sources (simulation, experimental, space, etc.). | +| | +| The focus of an analysis routine should be made as broad as possible. | +| When the routine's functionality becomes highly-tailored to its | +| application, then it should be placed into an appropriate explicit | +| namespace. | +------------------------------------------------------------------------------+ | .. _analysis: | | | @@ -141,7 +165,7 @@ Top-Level Sub-Packages | All types of particles in this sub-package should be able to be | | instantiated through a particle factory class, ``Particle``. | +------------------------------------------------------------------------------+ -| .. _plasma: | +| .. _plasma: | | | | **plasma** | +------------------------------------------------------------------------------+ From e6ce0bd66645d158fce10c64d4eb0ca0678fecc5 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Thu, 30 Jan 2020 17:38:21 -0800 Subject: [PATCH 35/65] update description of all sub-packages; remove sub-package "examples" --- PLEP-0007.rst | 102 ++++++++++++++++++++++++-------------------------- 1 file changed, 48 insertions(+), 54 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index d0dd583..9af3f9f 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -60,8 +60,8 @@ Top-Level Sub-Packages #. `tests`_ #. `utils`_ -.. _`native namespace package`: https://packaging.python.org/guides/packaging-namespace-packages/#native-namespace-packages -.. _`PEP 420`: https://www.python.org/dev/peps/pep-0420/ +.. _`PlasmaPy`: https://www.plasmapy.org/ +.. _`NRL Plasma Formulary`: https://www.nrl.navy.mil/ppd/content/nrl-plasma-formulary +------------------------------------------------------------------------------+ | .. _addons: | @@ -72,17 +72,19 @@ Top-Level Sub-Packages | :access: ``plasmapy.addons`` | | :PLEP: | | :scope: | -| The ``addons`` sub-package is a `native namespace package`_ setup | -| in accordance with the `PEP 420`_ guidelines. | +| The ``addons`` sub-package is intended to be a plugin location to allow | +| 3rd party users to extent the capabilities of `PlasmaPy`_. | | | -| A collection of functions, classes, and sub-packages focused on providing | -| analysis techniques that can be applied to data collected from a variety | -| of sources (simulation, experimental, space, etc.). | +| `PlasmaPy`_'s primary goal is to provide common functionality to the | +| plasma community as a whole and avoids getting too focused on | +| resources/functionality that are specific to a research group, instrument, | +| laboratory, etc. However, we do see the benefit of having this | +| functionality available in the `PlasmaPy`_ ecosystem. This ``addons`` | +| entry point allows for the PlasmaPy community to develop separate | +| open-source distributions that extend the functionality of ``plasmapy``. | | | -| The focus of an analysis routine should be made as broad as possible. | -| When the routine's functionality becomes highly-tailored to its | -| application, then it should be placed into an appropriate explicit | -| namespace. | +| .. note:: How to extend `PlasmaPy`_ by adding to ``plasmapy.addons`` will | +| be covered in a future PLEP. | +------------------------------------------------------------------------------+ | .. _analysis: | | | @@ -92,14 +94,15 @@ Top-Level Sub-Packages | :access: ``plasmapy.analysis`` | | :PLEP: | | :scope: | -| A collection of functions, classes, and sub-packages focused on providing | -| analysis techniques that can be applied to data collected from a variety | -| of sources (simulation, experimental, space, etc.). | +| A sub-package focused on providing analysis techniques that can be | +| applied to data collected from a variety of sources (simulation, | +| experimental, space, etc.). | | | | The focus of an analysis routine should be made as broad as possible. | | When the routine's functionality becomes highly-tailored to its | -| application, then it should be placed into an appropriate explicit | -| namespace. | +| application, then it should be placed into an explicitly appropriate | +| namespace. For example, linear, langmuir, magnetic-flux, etc. analysis | +| tools should be placed in their respective namespaces. | +------------------------------------------------------------------------------+ | .. _diagnostics: | | | @@ -109,18 +112,18 @@ Top-Level Sub-Packages | :access: ``plasmapy.diagnostics`` | | :PLEP: | | :scope: | -| A collection of functions, classes, and sub-packages that fully defines | -| the parameters of a "diagnostic." A "diagnostic" is any data collecting | -| instrument ranging from experimental probes, like Langmuir and magnetic | -| flux probes, to analogous synthetic diagnostics for simulations. | +| A sub-package that fully defines the parameters of a "diagnostic." A | +| "diagnostic" is any data collecting instrument ranging from experimental | +| probes, like Langmuir and magnetic flux probes, to analogous synthetic | +| diagnostics for simulations. | | | | Tools in this package do not define any analysis routines, but focus on | | defining probe characteristics/calibrations that can be seamlessly passed | | to ``plasmapy.analysis`` routines. | | | -| A ``Diagnostic`` class should fully define its diagnostic characteristics | -| and provide access to its most relevant analysis tools found in | -| ``plasmapy.analysis``. | +| A "``Diagnostic``" class should fully define its diagnostic | +| characteristics and provide access to its most relevant analysis tools | +| found in ``plasmapy.analysis``. | +------------------------------------------------------------------------------+ | .. _dispersion: | | | @@ -130,8 +133,7 @@ Top-Level Sub-Packages | :access: ``plasmapy.dispersion`` | | :PLEP: | | :scope: | -| A collection of functions, classes, and sub-packages dedicated to solving | -| various plasma dispersion relations. | +| A sub-package dedicated to solving various plasma dispersion relations. | | | | All dispersion solvers defined in this sub-package should be accessible | | through a dispersion solver factory class, ``DispersionSolver``. | @@ -144,9 +146,9 @@ Top-Level Sub-Packages | :access: ``plasmapy.formulary`` | | :PLEP: | | :scope: | -| A collection of functions, classes, and sub-packages that provide | -| mathematical and scientific formulas for calculating physical parameters | -| of various plasmas. | +| A sub-package that provides mathematical and scientific formulas for | +| calculating physical parameters of various plasmas. This is inspired by, | +| and akin to, the `NRL Plasma Formulary`_. | +------------------------------------------------------------------------------+ | .. _particles: | | | @@ -156,14 +158,11 @@ Top-Level Sub-Packages | :access: ``plasmapy.particles`` | | :PLEP: | | :scope: | -| A collection of functions, classes, and sub-packages that fully defines | -| the properties of a "particle." A "particle" can come in many forms | -| ranging from a traditional particle (electron, ion, atom, etc.) to more | -| exotic types like dust particles, dimensionless particles for simulations, | -| super-particles for simulations, etc. | -| | -| All types of particles in this sub-package should be able to be | -| instantiated through a particle factory class, ``Particle``. | +| A sub-package that fully defines the properties of a "particle." A | +| "particle" can come in many forms ranging from a traditional particle | +| (electron, ion, atom, etc.) to more exotic types like dust particles, | +| dimensionless particles for simulations, super-particles for simulations, | +| etc. | +------------------------------------------------------------------------------+ | .. _plasma: | | | @@ -173,12 +172,12 @@ Top-Level Sub-Packages | :access: ``plasmapy.plasma`` | | :PLEP: | | :scope: | -| A collection of functions, classes, and sub-packages that fully defines a | -| plasma. This would include the plasma's species constituents and physical | -| parameters (like temperature, boundary conditions, magnetic fields, etc.). | +| A sub-package that fully defines a plasma. This would include the | +| plasma's species constituents and physical parameters (like temperature, | +| boundary conditions, magnetic fields, etc.). | | | | Any tools that go into defining a plasma or its environment (e.g. a field | -| solver) should be included in a sub-package withing ``plasmapy.plasma``. | +| solver) should be included in a sub-package within ``plasmapy.plasma``. | +------------------------------------------------------------------------------+ | .. _simulation: | | | @@ -188,12 +187,12 @@ Top-Level Sub-Packages | :access: ``plasmapy.simulation`` | | :PLEP: | | :scope: | -| A collection of functions, classes, and sub-packages focused on | -| interfacing with simulations and/or running simulations. | +| A sub-package focused on interfacing with simulations and/or running | +| simulations. | | | | If a new feature falls under the scope of the ``analysis`` and/or | | ``diagnostics`` sub-packages, then the feature should be included one of | -| respective packages. For example, a synthetic diagnostic should be | +| respective sub-packages. For example, a synthetic diagnostic should be | | included in the ``plasmapy.diagnostics`` sub-package. | +------------------------------------------------------------------------------+ | .. _tests: | @@ -206,6 +205,9 @@ Top-Level Sub-Packages | :scope: | | A collection of tests for top-level modules (i.e. functions and classes | | defined in top-level ``.py`` files). | +| | +| Utility's associated with running and developing tests (e.g. | +| ``pytest_helpers``) should also be included here over ``plasmapy.utils``. | +------------------------------------------------------------------------------+ | .. _utils: | | | @@ -220,19 +222,11 @@ Top-Level Sub-Packages | | | This collection does not provide any physics tools, instead it is | | focused on providing package development tools. | +| | +| .. note:: Utilities focused on running and developing tests should be | +| placed in ``plasmapy.tests`` instead. | +------------------------------------------------------------------------------+ -.. +------------------------------------------------------------------------------+ - | **examples** | - +------------------------------------------------------------------------------+ - | :directory: ``./plasmapy/examples/`` | - | :access: ``plasmapy.examples`` | - | :PLEP: | - | :scope: | - | A collection of routines showing how to use and/or interface with the | - | various PlasmaPy tools. | - +------------------------------------------------------------------------------+ - Implementation ============== From 36a5a969e7c82766d14aadca26ef9d12db9a5592 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Thu, 30 Jan 2020 17:39:47 -0800 Subject: [PATCH 36/65] remove section "Alternatives" --- PLEP-0007.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 9af3f9f..592130f 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -243,12 +243,6 @@ Backward Compatibility This PLEP will NOT maintain backward compatibility. -Alternatives -============ - -*Summarize alternative possibilities to address (or not address) the -problem described in this PLEP, if necessary.* - Decision Rationale ================== From 87d0f94365fcf4d92749cb85d633011202224bf5 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Thu, 30 Jan 2020 17:41:23 -0800 Subject: [PATCH 37/65] fix table boarders --- PLEP-0007.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 592130f..ccff9eb 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -146,7 +146,7 @@ Top-Level Sub-Packages | :access: ``plasmapy.formulary`` | | :PLEP: | | :scope: | -| A sub-package that provides mathematical and scientific formulas for | +| A sub-package that provides mathematical and scientific formulas for | | calculating physical parameters of various plasmas. This is inspired by, | | and akin to, the `NRL Plasma Formulary`_. | +------------------------------------------------------------------------------+ @@ -158,7 +158,7 @@ Top-Level Sub-Packages | :access: ``plasmapy.particles`` | | :PLEP: | | :scope: | -| A sub-package that fully defines the properties of a "particle." A | +| A sub-package that fully defines the properties of a "particle." A | | "particle" can come in many forms ranging from a traditional particle | | (electron, ion, atom, etc.) to more exotic types like dust particles, | | dimensionless particles for simulations, super-particles for simulations, | @@ -172,7 +172,7 @@ Top-Level Sub-Packages | :access: ``plasmapy.plasma`` | | :PLEP: | | :scope: | -| A sub-package that fully defines a plasma. This would include the | +| A sub-package that fully defines a plasma. This would include the | | plasma's species constituents and physical parameters (like temperature, | | boundary conditions, magnetic fields, etc.). | | | @@ -187,7 +187,7 @@ Top-Level Sub-Packages | :access: ``plasmapy.simulation`` | | :PLEP: | | :scope: | -| A sub-package focused on interfacing with simulations and/or running | +| A sub-package focused on interfacing with simulations and/or running | | simulations. | | | | If a new feature falls under the scope of the ``analysis`` and/or | From 7ab5a333531f76a1770beac8d3bb7266bd2b0aeb Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Thu, 30 Jan 2020 17:41:57 -0800 Subject: [PATCH 38/65] write section "Decision Rationale" --- PLEP-0007.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index ccff9eb..a8ca12a 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -246,9 +246,5 @@ This PLEP will NOT maintain backward compatibility. Decision Rationale ================== -*Summarize the discussion on this PLEP and describe the reasoning -behind the decision, if necessary.* - -*Not all PLEPs require all of these sections, and occasionally -additional sections may be necessary. Emphasized text should be -deleted.* +Defining a top-level namespace for ``plasmapy`` will prevent namespace +pollution and help guide developers on where to place new code. From 87a2509aee683c02229921eb95261d6fa5e5a1db Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Thu, 30 Jan 2020 19:57:02 -0800 Subject: [PATCH 39/65] write sections "Implementation" and "Issues, Pull Requests, and Branches" --- PLEP-0007.rst | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index a8ca12a..39c67f9 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -230,13 +230,25 @@ Top-Level Sub-Packages Implementation ============== -*Describe the steps necessary to implement this PLEP, if necessary.* +Implementing this PLEP requires refactoring (renaming of moving) of existing +modules and sub-packages into the structure defined by this PLEP. + +Implementation of this PLEP was started in the development of ``plasmapy`` +``v0.3.0``. Issues, Pull Requests, and Branches =================================== -*Provide repository links related to this PLEP, and include -descriptions.* +All issues and pull requests were managed under the GitHub project +`PLEP-0007 Implementation `_. +The key pull requests were: + +* `PR #692 `_: + "plasmapy.formulary - reshuffle" +* `PR #742 `_: + "Rename plasmapy.atomic to plasmapy.particles" +* `PR #728 `_: + "Refactor pytest helper functionality" Backward Compatibility ====================== From b982d7b0260e85ca2cd16847bebe184042dbb172 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Thu, 30 Jan 2020 19:59:36 -0800 Subject: [PATCH 40/65] a little rewording --- PLEP-0007.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 39c67f9..bbd55d8 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -233,8 +233,8 @@ Implementation Implementing this PLEP requires refactoring (renaming of moving) of existing modules and sub-packages into the structure defined by this PLEP. -Implementation of this PLEP was started in the development of ``plasmapy`` -``v0.3.0``. +Implementation of this PLEP was started during the development of ``plasmapy +v0.3.0``. Issues, Pull Requests, and Branches =================================== From fd055feed49533eaa82c4968f06ddb9a554a4507 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Fri, 31 Jan 2020 11:15:20 -0800 Subject: [PATCH 41/65] add to the reasoning "help users navigate to the functionality they need" --- PLEP-0007.rst | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index bbd55d8..74cc8e5 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -29,10 +29,14 @@ This PLEP defines the top-level structure of ``PlasmaPy`` (i.e. ``plasmapy.``). Its intent is to name the top-level sub-packages and define the general scope of the code they encompass. Sub-package details are left to be defined in package focused -PLEPs, which should *NOT* conflict with this PLEP. This -structure should help developers decided where new code should be -placed and keep the top-level namespace from getting bloated. If -new code does NOT fall within the current framework, then this PLEP +PLEPs, which should *NOT* conflict with this PLEP. Defining this +structure should: + + #. keep the top-level namespace from getting bloated. + #. help developers decided where new code should be placed + #. help navigate users to the functionality they need + +If new code does NOT fall within the current framework, then this PLEP needs to be modified/updated accordingly before any new top-level sub-packages are created. @@ -42,9 +46,12 @@ Detailed Description Why? ---- -By defining a top-level sub-package namespace, developers are better -directed to where code can be added and the ``PlasmaPy`` -**Coordinating Committee** can better manage package bloat. +By defining a top-level sub-package namespace developers are better +directed to where code can be added, the ``PlasmaPy`` +`Coordinating Committee +`_ +can better manage package bloat, and users are better directed to the code +they need. Top-Level Sub-Packages ---------------------- From a08cdc8bb5b170eb3f091ea637c8b39a2b19c425 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Fri, 31 Jan 2020 11:17:33 -0800 Subject: [PATCH 42/65] add PLEP to the README table --- README.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.rst b/README.rst index 0763455..a61d022 100644 --- a/README.rst +++ b/README.rst @@ -35,3 +35,6 @@ convenience, an abbreviated index of PLEPs is provided below. | 6 | `A New General-Purpose Plasma Object <./PLEP-0006.rst>`__ | .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1460977.svg | | | | :target: http://doi.org/10.5281/zenodo.1460977 | +--------+----------------------------------------------------------------------------------+--------------------------------------------------------------------+ +| 7 | `Structure of Top-Level Sub-Packages <./PLEP-0007.rst>`__ | | +| | | | ++--------+----------------------------------------------------------------------------------+--------------------------------------------------------------------+ From 1bc8c02abfaa1dd97ade800e953dd7de0fa0754c Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Fri, 31 Jan 2020 11:40:10 -0800 Subject: [PATCH 43/65] update given Nicks code review --- PLEP-0007.rst | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 74cc8e5..a1685bf 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -141,9 +141,6 @@ Top-Level Sub-Packages | :PLEP: | | :scope: | | A sub-package dedicated to solving various plasma dispersion relations. | -| | -| All dispersion solvers defined in this sub-package should be accessible | -| through a dispersion solver factory class, ``DispersionSolver``. | +------------------------------------------------------------------------------+ | .. _formulary: | | | @@ -181,7 +178,7 @@ Top-Level Sub-Packages | :scope: | | A sub-package that fully defines a plasma. This would include the | | plasma's species constituents and physical parameters (like temperature, | -| boundary conditions, magnetic fields, etc.). | +| boundary conditions, magnetic fields, distribution functions, etc.). | | | | Any tools that go into defining a plasma or its environment (e.g. a field | | solver) should be included in a sub-package within ``plasmapy.plasma``. | @@ -213,8 +210,9 @@ Top-Level Sub-Packages | A collection of tests for top-level modules (i.e. functions and classes | | defined in top-level ``.py`` files). | | | -| Utility's associated with running and developing tests (e.g. | -| ``pytest_helpers``) should also be included here over ``plasmapy.utils``. | +| .. note:: Utility's associated with running and developing tests (e.g. | +| "pytest helpers") should also be included here over | +| ``plasmapy.utils``. | +------------------------------------------------------------------------------+ | .. _utils: | | | @@ -237,8 +235,9 @@ Top-Level Sub-Packages Implementation ============== -Implementing this PLEP requires refactoring (renaming of moving) of existing -modules and sub-packages into the structure defined by this PLEP. +Implementing this PLEP requires creation of new sub-packages and refactoring +(renaming and/or moving) of existing modules and sub-packages into the +structure defined by this PLEP. Implementation of this PLEP was started during the development of ``plasmapy v0.3.0``. From 8054ee4954e01ff584bb3393ca6c47d8d823cba5 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Fri, 31 Jan 2020 18:44:47 -0800 Subject: [PATCH 44/65] re-word description of the dispersion section --- PLEP-0007.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index a1685bf..3836c70 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -140,7 +140,9 @@ Top-Level Sub-Packages | :access: ``plasmapy.dispersion`` | | :PLEP: | | :scope: | -| A sub-package dedicated to solving various plasma dispersion relations. | +| A sub-package containing tools to work with plasma dispersion relations. | +| This includes, but is not limited to, solving dispersion relations, | +| defining dispersion functions, plotting dispersion relations, etc. | +------------------------------------------------------------------------------+ | .. _formulary: | | | From e793c3f48389773489bb907897f0d64abe6519fd Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Tue, 18 Feb 2020 10:51:44 -0800 Subject: [PATCH 45/65] wording clairfication for plasmapy.analysis description Co-Authored-By: Nick Murphy --- PLEP-0007.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 3836c70..cf16f1a 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -109,7 +109,8 @@ Top-Level Sub-Packages | When the routine's functionality becomes highly-tailored to its | | application, then it should be placed into an explicitly appropriate | | namespace. For example, linear, langmuir, magnetic-flux, etc. analysis | -| tools should be placed in their respective namespaces. | +| tools should be placed in their respective namespaces within | +| ``plasmapy.analysis``. | +------------------------------------------------------------------------------+ | .. _diagnostics: | | | From a7a44699a56d59a2457b36303f3af54b98dd0101 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Tue, 18 Feb 2020 10:56:21 -0800 Subject: [PATCH 46/65] re-word plasmapy.simulation description --- PLEP-0007.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index cf16f1a..12c273f 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -198,8 +198,8 @@ Top-Level Sub-Packages | simulations. | | | | If a new feature falls under the scope of the ``analysis`` and/or | -| ``diagnostics`` sub-packages, then the feature should be included one of | -| respective sub-packages. For example, a synthetic diagnostic should be | +| ``diagnostics`` sub-packages, then the new feature should be included in | +| one of those sub-packages. For example, a synthetic diagnostic should be | | included in the ``plasmapy.diagnostics`` sub-package. | +------------------------------------------------------------------------------+ | .. _tests: | From 157945a68b1d8547ea000488eaf5de6ec7a49d73 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Tue, 18 Feb 2020 10:58:03 -0800 Subject: [PATCH 47/65] Utilities is plural, not possessive Co-Authored-By: Nick Murphy --- PLEP-0007.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 12c273f..f898ede 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -213,7 +213,7 @@ Top-Level Sub-Packages | A collection of tests for top-level modules (i.e. functions and classes | | defined in top-level ``.py`` files). | | | -| .. note:: Utility's associated with running and developing tests (e.g. | +| .. note:: Utilities associated with running and developing tests (e.g. | | "pytest helpers") should also be included here over | | ``plasmapy.utils``. | +------------------------------------------------------------------------------+ From 5b80c73cefb164f0f22cc3b35ecc74e40b27d6d3 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Wed, 29 Apr 2020 14:12:54 -0700 Subject: [PATCH 48/65] attempting to make tables look clean when rendering rst and converting to pdf --- PLEP-0007.rst | 56 ++++++++++++++++++++++++++++++--------------------- 1 file changed, 33 insertions(+), 23 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index f898ede..85ad5c3 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -56,6 +56,9 @@ they need. Top-Level Sub-Packages ---------------------- +.. _`PlasmaPy`: https://www.plasmapy.org/ +.. _`NRL Plasma Formulary`: https://www.nrl.navy.mil/ppd/content/nrl-plasma-formulary + #. `addons`_ #. `analysis`_ #. `diagnostics`_ @@ -67,31 +70,38 @@ Top-Level Sub-Packages #. `tests`_ #. `utils`_ -.. _`PlasmaPy`: https://www.plasmapy.org/ -.. _`NRL Plasma Formulary`: https://www.nrl.navy.mil/ppd/content/nrl-plasma-formulary +.. _addons: -+------------------------------------------------------------------------------+ -| .. _addons: | -| | ++------------+-----------------------------------------------------------------+ | **addons** | -+------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/addons/`` | -| :access: ``plasmapy.addons`` | -| :PLEP: | -| :scope: | -| The ``addons`` sub-package is intended to be a plugin location to allow | -| 3rd party users to extent the capabilities of `PlasmaPy`_. | -| | -| `PlasmaPy`_'s primary goal is to provide common functionality to the | -| plasma community as a whole and avoids getting too focused on | -| resources/functionality that are specific to a research group, instrument, | -| laboratory, etc. However, we do see the benefit of having this | -| functionality available in the `PlasmaPy`_ ecosystem. This ``addons`` | -| entry point allows for the PlasmaPy community to develop separate | -| open-source distributions that extend the functionality of ``plasmapy``. | -| | -| .. note:: How to extend `PlasmaPy`_ by adding to ``plasmapy.addons`` will | -| be covered in a future PLEP. | ++============+=================================================================+ +| directory: | ``./plasmapy/addons/`` | ++------------+-----------------------------------------------------------------+ +| access: | ``plasmapy.addons`` | ++------------+-----------------------------------------------------------------+ +| PLEP: | | ++------------+-----------------------------------------------------------------+ +| scope: | | The ``addons`` sub-package is intended to be a plugin | +| | location to allow 3rd party users to extent the capabilities | +| | of `PlasmaPy`_. | +| | | | +| | | `PlasmaPy`_'s primary goal is to provide common functionality | +| | to the plasma community as a whole and avoids getting too | +| | focused on resources/functionality that are specific to a | +| | research group, instrument, laboratory, etc. However, we do | +| | see the benefit of having this functionality available in the | +| | `PlasmaPy`_ ecosystem. This ``addons`` entry point allows | +| | for the PlasmaPy community to develop separate open-source | +| | distributions that extend the functionality of ``plasmapy``. | +| | | | +| | | +| | .. note:: How to extend `PlasmaPy`_ by adding to | +| | ``plasmapy.addons`` will be covered in a future PLEP. | ++------------+-----------------------------------------------------------------+ + +.. note:: How to extend `PlasmaPy`_ by adding to + ``plasmapy.addons`` will be covered in a future PLEP. + +------------------------------------------------------------------------------+ | .. _analysis: | | | From 0092bb8bcf7f0014f7103bebd08bdebc6894b1a7 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Wed, 29 Apr 2020 14:29:30 -0700 Subject: [PATCH 49/65] a few more changes to see how "notes" appear --- PLEP-0007.rst | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 85ad5c3..b7620fb 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -94,14 +94,11 @@ Top-Level Sub-Packages | | for the PlasmaPy community to develop separate open-source | | | distributions that extend the functionality of ``plasmapy``. | | | | | -| | | -| | .. note:: How to extend `PlasmaPy`_ by adding to | -| | ``plasmapy.addons`` will be covered in a future PLEP. | +| | | *Note:* | +| | | Extending `PlasmaPy`_ by adding to ``plasmapy.addons`` | +| | will be covered in a future PLEP. | +------------+-----------------------------------------------------------------+ -.. note:: How to extend `PlasmaPy`_ by adding to - ``plasmapy.addons`` will be covered in a future PLEP. - +------------------------------------------------------------------------------+ | .. _analysis: | | | From c8fba5ea7977f819a45d790c77c70e97512e823c Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Wed, 29 Apr 2020 14:58:31 -0700 Subject: [PATCH 50/65] update analysis table --- PLEP-0007.rst | 41 +++++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index b7620fb..161c2cc 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -99,25 +99,30 @@ Top-Level Sub-Packages | | will be covered in a future PLEP. | +------------+-----------------------------------------------------------------+ -+------------------------------------------------------------------------------+ -| .. _analysis: | -| | +.. _analysis: + ++------------+-----------------------------------------------------------------+ | **analysis** | -+------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/analysis/`` | -| :access: ``plasmapy.analysis`` | -| :PLEP: | -| :scope: | -| A sub-package focused on providing analysis techniques that can be | -| applied to data collected from a variety of sources (simulation, | -| experimental, space, etc.). | -| | -| The focus of an analysis routine should be made as broad as possible. | -| When the routine's functionality becomes highly-tailored to its | -| application, then it should be placed into an explicitly appropriate | -| namespace. For example, linear, langmuir, magnetic-flux, etc. analysis | -| tools should be placed in their respective namespaces within | -| ``plasmapy.analysis``. | ++============+=================================================================+ +| directory: | ``./plasmapy/analysis/`` | ++------------+-----------------------------------------------------------------+ +| access: | ``plasmapy.analysis`` | ++------------+-----------------------------------------------------------------+ +| PLEP: | | ++------------+-----------------------------------------------------------------+ +| scope: | | A sub-package focused on providing analysis techniques that | +| | can be applied to data collected from a variety of sources | +| | (simulation, experimental, space, etc.). | +| | | | +| | | The focus of an analysis routine should be made as broad as | +| | possible. When the routine's functionality becomes | +| | highly-tailored to its application, then it should be placed | +| | into an explicitly appropriate namespace. For example, | +| | linear, langmuir, magnetic-flux, etc. analysis tools should | +| | be placed in their respective namespaces within | +| | ``plasmapy.analysis``. | ++------------+-----------------------------------------------------------------+ + +------------------------------------------------------------------------------+ | .. _diagnostics: | | | From 12196475b22163eb95dbeda000e56a4075fcfa7b Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Wed, 29 Apr 2020 14:58:57 -0700 Subject: [PATCH 51/65] improve some wording and style formatting --- PLEP-0007.rst | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 161c2cc..bdc7cc8 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -46,8 +46,8 @@ Detailed Description Why? ---- -By defining a top-level sub-package namespace developers are better -directed to where code can be added, the ``PlasmaPy`` +By defining the top-level sub-package namespace developers are better +directed to where code should be added, the ``PlasmaPy`` `Coordinating Committee `_ can better manage package bloat, and users are better directed to the code @@ -59,16 +59,20 @@ Top-Level Sub-Packages .. _`PlasmaPy`: https://www.plasmapy.org/ .. _`NRL Plasma Formulary`: https://www.nrl.navy.mil/ppd/content/nrl-plasma-formulary -#. `addons`_ -#. `analysis`_ -#. `diagnostics`_ -#. `dispersion`_ -#. `formulary`_ -#. `particles`_ -#. `plasma`_ -#. `simulation`_ -#. `tests`_ -#. `utils`_ +The following sub-packages are outlined in this PLEP, with brief synopses given in +the tables below. The details of each package are left to be fully defined by their +respective package PLEPs. + + #. `addons`_ + #. `analysis`_ + #. `diagnostics`_ + #. `dispersion`_ + #. `formulary`_ + #. `particles`_ + #. `plasma`_ + #. `simulation`_ + #. `tests`_ + #. `utils`_ .. _addons: From e92d5155c51b8197553d6ede927a5bc6c8bcea05 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Thu, 30 Apr 2020 16:21:19 -0700 Subject: [PATCH 52/65] reformat tables so they look good as rst and pdf...pandoc does not support multicolumn --- PLEP-0007.rst | 389 ++++++++++++++++++++++++++++---------------------- 1 file changed, 218 insertions(+), 171 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index bdc7cc8..22520c2 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -76,180 +76,227 @@ respective package PLEPs. .. _addons: -+------------+-----------------------------------------------------------------+ -| **addons** | -+============+=================================================================+ -| directory: | ``./plasmapy/addons/`` | -+------------+-----------------------------------------------------------------+ -| access: | ``plasmapy.addons`` | -+------------+-----------------------------------------------------------------+ -| PLEP: | | -+------------+-----------------------------------------------------------------+ -| scope: | | The ``addons`` sub-package is intended to be a plugin | -| | location to allow 3rd party users to extent the capabilities | -| | of `PlasmaPy`_. | -| | | | -| | | `PlasmaPy`_'s primary goal is to provide common functionality | -| | to the plasma community as a whole and avoids getting too | -| | focused on resources/functionality that are specific to a | -| | research group, instrument, laboratory, etc. However, we do | -| | see the benefit of having this functionality available in the | -| | `PlasmaPy`_ ecosystem. This ``addons`` entry point allows | -| | for the PlasmaPy community to develop separate open-source | -| | distributions that extend the functionality of ``plasmapy``. | -| | | | -| | | *Note:* | -| | | Extending `PlasmaPy`_ by adding to ``plasmapy.addons`` | -| | will be covered in a future PLEP. | -+------------+-----------------------------------------------------------------+ ++-----------------+-------------------------------------------------------------+ +| **addons** | ++=================+=============================================================+ +| directory: | ``./plasmapy/addons/`` | ++-----------------+-------------------------------------------------------------+ +| access: | ``plasmapy.addons`` | ++-----------------+-------------------------------------------------------------+ +| PLEP: | | ++-----------------+-------------------------------------------------------------+ +| scope: | | The ``addons`` sub-package is intended to be a plugin | +| | location to allow 3rd party users to extent the | +| | capabilities of `PlasmaPy`_. | +| | | | +| | | `PlasmaPy`_'s primary goal is to provide common | +| | functionality to the plasma community as a whole and | +| | avoids getting too focused on resources/functionality | +| | that are specific to a research group, instrument, | +| | laboratory, etc. However, we do see the benefit of | +| | having this functionality available in the `PlasmaPy`_ | +| | ecosystem. This ``addons`` entry point allows for the | +| | PlasmaPy community to develop separate open-source | +| | distributions that extend the functionality of | +| | ``plasmapy``. | +| | | | +| | | *Note:* | +| | | Extending `PlasmaPy`_ by adding to ``plasmapy.addons`` | +| | will be covered in a future PLEP. | ++-----------------+-------------------------------------------------------------+ .. _analysis: -+------------+-----------------------------------------------------------------+ -| **analysis** | -+============+=================================================================+ -| directory: | ``./plasmapy/analysis/`` | -+------------+-----------------------------------------------------------------+ -| access: | ``plasmapy.analysis`` | -+------------+-----------------------------------------------------------------+ -| PLEP: | | -+------------+-----------------------------------------------------------------+ -| scope: | | A sub-package focused on providing analysis techniques that | -| | can be applied to data collected from a variety of sources | -| | (simulation, experimental, space, etc.). | -| | | | -| | | The focus of an analysis routine should be made as broad as | -| | possible. When the routine's functionality becomes | -| | highly-tailored to its application, then it should be placed | -| | into an explicitly appropriate namespace. For example, | -| | linear, langmuir, magnetic-flux, etc. analysis tools should | -| | be placed in their respective namespaces within | -| | ``plasmapy.analysis``. | -+------------+-----------------------------------------------------------------+ - -+------------------------------------------------------------------------------+ -| .. _diagnostics: | -| | -| **diagnostics** | -+------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/diagnostics/`` | -| :access: ``plasmapy.diagnostics`` | -| :PLEP: | -| :scope: | -| A sub-package that fully defines the parameters of a "diagnostic." A | -| "diagnostic" is any data collecting instrument ranging from experimental | -| probes, like Langmuir and magnetic flux probes, to analogous synthetic | -| diagnostics for simulations. | -| | -| Tools in this package do not define any analysis routines, but focus on | -| defining probe characteristics/calibrations that can be seamlessly passed | -| to ``plasmapy.analysis`` routines. | -| | -| A "``Diagnostic``" class should fully define its diagnostic | -| characteristics and provide access to its most relevant analysis tools | -| found in ``plasmapy.analysis``. | -+------------------------------------------------------------------------------+ -| .. _dispersion: | -| | -| **dispersion** | -+------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/dispersion/`` | -| :access: ``plasmapy.dispersion`` | -| :PLEP: | -| :scope: | -| A sub-package containing tools to work with plasma dispersion relations. | -| This includes, but is not limited to, solving dispersion relations, | -| defining dispersion functions, plotting dispersion relations, etc. | -+------------------------------------------------------------------------------+ -| .. _formulary: | -| | -| **formulary** | -+------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/formulary/`` | -| :access: ``plasmapy.formulary`` | -| :PLEP: | -| :scope: | -| A sub-package that provides mathematical and scientific formulas for | -| calculating physical parameters of various plasmas. This is inspired by, | -| and akin to, the `NRL Plasma Formulary`_. | -+------------------------------------------------------------------------------+ -| .. _particles: | -| | -| **particles** | -+------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/particles/`` | -| :access: ``plasmapy.particles`` | -| :PLEP: | -| :scope: | -| A sub-package that fully defines the properties of a "particle." A | -| "particle" can come in many forms ranging from a traditional particle | -| (electron, ion, atom, etc.) to more exotic types like dust particles, | -| dimensionless particles for simulations, super-particles for simulations, | -| etc. | -+------------------------------------------------------------------------------+ -| .. _plasma: | -| | -| **plasma** | -+------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/plasma/`` | -| :access: ``plasmapy.plasma`` | -| :PLEP: | -| :scope: | -| A sub-package that fully defines a plasma. This would include the | -| plasma's species constituents and physical parameters (like temperature, | -| boundary conditions, magnetic fields, distribution functions, etc.). | -| | -| Any tools that go into defining a plasma or its environment (e.g. a field | -| solver) should be included in a sub-package within ``plasmapy.plasma``. | -+------------------------------------------------------------------------------+ -| .. _simulation: | -| | -| **simulation** | -+------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/simulation/`` | -| :access: ``plasmapy.simulation`` | -| :PLEP: | -| :scope: | -| A sub-package focused on interfacing with simulations and/or running | -| simulations. | -| | -| If a new feature falls under the scope of the ``analysis`` and/or | -| ``diagnostics`` sub-packages, then the new feature should be included in | -| one of those sub-packages. For example, a synthetic diagnostic should be | -| included in the ``plasmapy.diagnostics`` sub-package. | -+------------------------------------------------------------------------------+ -| .. _tests: | -| | -| **tests** | -+------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/tests/`` | -| :access: ``plasmapy.tests`` | -| :PLEP: | -| :scope: | -| A collection of tests for top-level modules (i.e. functions and classes | -| defined in top-level ``.py`` files). | -| | -| .. note:: Utilities associated with running and developing tests (e.g. | -| "pytest helpers") should also be included here over | -| ``plasmapy.utils``. | -+------------------------------------------------------------------------------+ -| .. _utils: | -| | -| **utils** | -+------------------------------------------------------------------------------+ -| :directory: ``./plasmapy/utils/`` | -| :access: ``plasmapy.utils`` | -| :PLEP: | -| :scope: | -| A collection of "utility" functions and classes to help us write | -| (what we try to think of as) clean, readable, and informative code. | -| | -| This collection does not provide any physics tools, instead it is | -| focused on providing package development tools. | -| | -| .. note:: Utilities focused on running and developing tests should be | -| placed in ``plasmapy.tests`` instead. | -+------------------------------------------------------------------------------+ ++-----------------+-------------------------------------------------------------+ +| **analysis** | ++=================+=============================================================+ +| directory: | ``./plasmapy/analysis/`` | ++-----------------+-------------------------------------------------------------+ +| access: | ``plasmapy.analysis`` | ++-----------------+-------------------------------------------------------------+ +| PLEP: | | ++-----------------+-------------------------------------------------------------+ +| scope: | | A sub-package focused on providing analysis techniques | +| | that can be applied to data collected from a variety of | +| | sources (simulation, experimental, space, etc.). | +| | | | +| | | The focus of an analysis routine should be made as broad | +| | as possible. When the routine's functionality becomes | +| | highly-tailored to its application, then it should be | +| | placed into an explicitly appropriate namespace. For | +| | example, linear, langmuir, magnetic-flux, etc. analysis | +| | tools should be placed in their respective namespaces | +| | within ``plasmapy.analysis``. | ++-----------------+-------------------------------------------------------------+ + +.. _diagnostics: + ++-----------------+-------------------------------------------------------------+ +| **diagnostics** | ++=================+=============================================================+ +| directory: | ``./plasmapy/diagnostics/`` | ++-----------------+-------------------------------------------------------------+ +| access: | ``plasmapy.diagnostics`` | ++-----------------+-------------------------------------------------------------+ +| PLEP: | | ++-----------------+-------------------------------------------------------------+ +| scope: | | A sub-package that fully defines the parameters of a | +| | "diagnostic." A "diagnostic" is any data collecting | +| | instrument ranging from experimental probes, like | +| | Langmuir and magnetic flux probes, to analogous | +| | synthetic diagnostics for simulations. | +| | | | +| | | Tools in this package do not define any analysis | +| | routines, but focus on defining probe | +| | characteristics/calibrations that can be seamlessly | +| | passed to ``plasmapy.analysis`` routines. | +| | | | +| | | A "``Diagnostic``" class should fully define its | +| | diagnostic characteristics and provide access to its | +| | most relevant analysis tools found in | +| | ``plasmapy.analysis``. | ++-----------------+-------------------------------------------------------------+ + +.. _dispersion: + ++-----------------+-------------------------------------------------------------+ +| **dispersion** | ++=================+=============================================================+ +| directory: | ``./plasmapy/dispersion/`` | ++-----------------+-------------------------------------------------------------+ +| access: | ``plasmapy.dispersion`` | ++-----------------+-------------------------------------------------------------+ +| PLEP: | | ++-----------------+-------------------------------------------------------------+ +| scope: | A sub-package containing tools to work with plasma | +| | dispersion relations. This includes, but is not limited | +| | to, solving dispersion relations, defining dispersion | +| | functions, plotting dispersion relations, etc. | ++-----------------+-------------------------------------------------------------+ + +.. _formulary: + ++-----------------+-------------------------------------------------------------+ +| **formulary** | ++=================+=============================================================+ +| directory: | ``./plasmapy/formulary/`` | ++-----------------+-------------------------------------------------------------+ +| access: | ``plasmapy.formulary`` | ++-----------------+-------------------------------------------------------------+ +| PLEP: | | ++-----------------+-------------------------------------------------------------+ +| scope: | A sub-package that provides mathematical and scientific | +| | formulas for calculating physical parameters of various | +| | plasmas. This is inspired by, and akin to, the | +| | `NRL Plasma Formulary`_. | ++-----------------+-------------------------------------------------------------+ + +.. _particles: + ++-----------------+-------------------------------------------------------------+ +| **particles** | ++=================+=============================================================+ +| directory: | ``./plasmapy/particles/`` | ++-----------------+-------------------------------------------------------------+ +| access: | ``plasmapy.particles`` | ++-----------------+-------------------------------------------------------------+ +| PLEP: | | ++-----------------+-------------------------------------------------------------+ +| scope: | A sub-package that fully defines the properties of a | +| | "particle." A "particle" can come in many forms ranging | +| | from a traditional particle (electron, ion, atom, etc.) to | +| | more exotic types like dust particles, dimensionless | +| | particles for simulations, super-particles for simulations, | +| | etc. | ++-----------------+-------------------------------------------------------------+ + +.. _plasma: + ++-----------------+-------------------------------------------------------------+ +| **plasma** | ++=================+=============================================================+ +| directory: | ``./plasmapy/plasma/`` | ++-----------------+-------------------------------------------------------------+ +| access: | ``plasmapy.plasma`` | ++-----------------+-------------------------------------------------------------+ +| PLEP: | | ++-----------------+-------------------------------------------------------------+ +| scope: | | A sub-package that fully defines a plasma. This would | +| | include the plasma's species constituents and physical | +| | parameters (like temperature, boundary conditions, | +| | magnetic fields, distribution functions, etc.). | +| | | | +| | | Any tools that go into defining a plasma or its | +| | environment (e.g. a field solver) should be included in | +| | a sub-package within ``plasmapy.plasma``. | ++-----------------+-------------------------------------------------------------+ + +.. _simulation: + ++-----------------+-------------------------------------------------------------+ +| **simulation** | ++=================+=============================================================+ +| directory: | ``./plasmapy/simulation/`` | ++-----------------+-------------------------------------------------------------+ +| access: | ``plasmapy.simulation`` | ++-----------------+-------------------------------------------------------------+ +| PLEP: | | ++-----------------+-------------------------------------------------------------+ +| scope: | | A sub-package focused on interfacing with simulations | +| | and/or running simulations. | +| | | | +| | | If a new feature falls under the scope of the | +| | ``analysis`` and/or ``diagnostics`` sub-packages, then | +| | the new feature should be included in one of those | +| | sub-packages. For example, a synthetic diagnostic | +| | should be included in the ``plasmapy.diagnostics`` | +| | sub-package. | ++-----------------+-------------------------------------------------------------+ + +.. _tests: + ++-----------------+-------------------------------------------------------------+ +| **tests** | ++=================+=============================================================+ +| directory: | ``./plasmapy/tests/`` | ++-----------------+-------------------------------------------------------------+ +| access: | ``plasmapy.tests`` | ++-----------------+-------------------------------------------------------------+ +| PLEP: | | ++-----------------+-------------------------------------------------------------+ +| scope: | | A collection of tests for top-level modules (i.e. | +| | functions and classes defined in top-level ``.py`` | +| | files). | +| | | | +| | | *Note:* | +| | | Utilities associated with running and developing tests | +| | (e.g. "pytest helpers") should also be included here over | +| | ``plasmapy.utils``. | ++-----------------+-------------------------------------------------------------+ + +.. _utils: + ++-----------------+-------------------------------------------------------------+ +| **utils** | ++=================+=============================================================+ +| directory: | ``./plasmapy/utils/`` | ++-----------------+-------------------------------------------------------------+ +| access: | ``plasmapy.utils`` | ++-----------------+-------------------------------------------------------------+ +| PLEP: | | ++-----------------+-------------------------------------------------------------+ +| scope: | | A collection of "utility" functions and classes to help | +| | us write (what we try to think of as) clean, readable, | +| | and informative code. | +| | | | +| | | This collection does not provide any physics tools, | +| | instead it is focused on providing package development | +| | tools. | +| | | | +| | | *Note:* | +| | | Utilities focused on running and developing tests should | +| | be placed in ``plasmapy.tests`` instead. | ++-----------------+-------------------------------------------------------------+ Implementation ============== From 3ab4e72cfc6b7a84b1354192e3e8d2b8b0c206ba Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Thu, 30 Apr 2020 16:24:08 -0700 Subject: [PATCH 53/65] how do section look vs table headings --- PLEP-0007.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 22520c2..81b0f15 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -76,9 +76,13 @@ respective package PLEPs. .. _addons: +addons +****** + +.. | **addons** | + +=================+=============================================================+ + +-----------------+-------------------------------------------------------------+ -| **addons** | -+=================+=============================================================+ | directory: | ``./plasmapy/addons/`` | +-----------------+-------------------------------------------------------------+ | access: | ``plasmapy.addons`` | @@ -107,9 +111,13 @@ respective package PLEPs. .. _analysis: +analysis +******** + +.. | **analysis** | + +=================+=============================================================+ + +-----------------+-------------------------------------------------------------+ -| **analysis** | -+=================+=============================================================+ | directory: | ``./plasmapy/analysis/`` | +-----------------+-------------------------------------------------------------+ | access: | ``plasmapy.analysis`` | From 0dcafe411bd965aac1dada2d7552e72018b9797e Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Thu, 30 Apr 2020 16:45:43 -0700 Subject: [PATCH 54/65] Revert "how do section look vs table headings" This reverts commit 3ab4e72c --- PLEP-0007.rst | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 81b0f15..22520c2 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -76,13 +76,9 @@ respective package PLEPs. .. _addons: -addons -****** - -.. | **addons** | - +=================+=============================================================+ - +-----------------+-------------------------------------------------------------+ +| **addons** | ++=================+=============================================================+ | directory: | ``./plasmapy/addons/`` | +-----------------+-------------------------------------------------------------+ | access: | ``plasmapy.addons`` | @@ -111,13 +107,9 @@ addons .. _analysis: -analysis -******** - -.. | **analysis** | - +=================+=============================================================+ - +-----------------+-------------------------------------------------------------+ +| **analysis** | ++=================+=============================================================+ | directory: | ``./plasmapy/analysis/`` | +-----------------+-------------------------------------------------------------+ | access: | ``plasmapy.analysis`` | From 0b3be4f148d1e9c7857e6c032432f414cc015f7c Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Thu, 30 Apr 2020 17:54:48 -0700 Subject: [PATCH 55/65] add clause about exempting extensible packages --- PLEP-0007.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 22520c2..8e15cb3 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -298,6 +298,17 @@ respective package PLEPs. | | be placed in ``plasmapy.tests`` instead. | +-----------------+-------------------------------------------------------------+ +Extensible Packages are Exempt +============================== + +Any package separately distributed from ``plasmapy`` does not need to go through a +PLEP-7 review to add a top-level package to ``plasmapy``. For example, a +``plasmapy-foo`` distribution does not require a PLEP-7 review to create the extensible +sub-package ``plasmapy.foo``. The reasoning here is (1) this top-level sub-package +``plasmapy.foo`` is not distributed with the main ``plasmapy`` package and (2) any +user is purposefully installing the extensible package ``plasmapy-foo``. + + Implementation ============== From a2c504947cdb83498d7856976f3a006d8cb5a40e Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Thu, 30 Apr 2020 17:55:37 -0700 Subject: [PATCH 56/65] manually add a table of contents since pandoc does not support the RST content directive...arggg --- PLEP-0007.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 8e15cb3..118e38d 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -22,6 +22,20 @@ PLEP-0007 – Structure of Top-Level Sub-Packages | | | +-------------------+---------------------------------------------+ +**Contents** + +* `Abstract`_ +* `Detailed Description`_ + + * `Why?`_ + * `Top-Level Sub-Packages`_ + +* `Extensible Packages are Exempt`_ +* `Implementation`_ +* `Issues, Pull Requests, and Branches`_ +* `Backward Compatibility`_ +* `Decision Rationale`_ + Abstract ======== From f7945369e1cdcea8540ecb09ee497a6f65b3009d Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Thu, 30 Apr 2020 17:56:13 -0700 Subject: [PATCH 57/65] reduce wordiness --- PLEP-0007.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 118e38d..867494d 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -41,12 +41,12 @@ Abstract This PLEP defines the top-level structure of ``PlasmaPy`` (i.e. ``plasmapy.``). Its intent is to name the top-level -sub-packages and define the general scope of the code they encompass. -Sub-package details are left to be defined in package focused -PLEPs, which should *NOT* conflict with this PLEP. Defining this +sub-packages and define the general scope of each package. +Sub-package details are left to be defined in package focused PLEPs, +which should *NOT* conflict with this PLEP. Defining the top-level structure should: - #. keep the top-level namespace from getting bloated. + #. keep the top-level namespace from getting bloated #. help developers decided where new code should be placed #. help navigate users to the functionality they need @@ -327,8 +327,8 @@ Implementation ============== Implementing this PLEP requires creation of new sub-packages and refactoring -(renaming and/or moving) of existing modules and sub-packages into the -structure defined by this PLEP. +(renaming and/or moving) of existing modules and sub-packages into the outlined +structure. Implementation of this PLEP was started during the development of ``plasmapy v0.3.0``. @@ -355,5 +355,6 @@ This PLEP will NOT maintain backward compatibility. Decision Rationale ================== -Defining a top-level namespace for ``plasmapy`` will prevent namespace -pollution and help guide developers on where to place new code. +Defining a top-level namespace for ``plasmapy`` will (1) prevent namespace +pollution, (2) help guide developers on where to place new code, and (3) help +navigate users to the functionality they need. From 46b043c566b01e9630349cb976adab3e4d82ae8d Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Fri, 1 May 2020 16:52:42 -0700 Subject: [PATCH 58/65] add DOI and last revised date --- PLEP-0007.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 867494d..66af94b 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -2,23 +2,27 @@ PLEP-0007 – Structure of Top-Level Sub-Packages =============================================== +.. _`10.5281/zenodo.3774573`: https://doi.org/10.5281/zenodo.3774573 + +-------------------+---------------------------------------------+ | PLEP | 7 | +===================+=============================================+ -| author(s) | Erik T. Everson, Tulasi Parashar, | -| | Steve Vincena, Nicholas A. Murphy | +| author(s) | | Erik T. Everson | +| | | Tulasi Parashar, | +| | | Steve Vincena | +| | | Nicholas A. Murphy | +-------------------+---------------------------------------------+ | contact email | eeverson@ucla.edu | +-------------------+---------------------------------------------+ | date created | 2019-10-27 | +-------------------+---------------------------------------------+ -| date last revised | *YYYY-MM-DD* | +| date last revised | 2020-05-01 | +-------------------+---------------------------------------------+ | type | standard | +-------------------+---------------------------------------------+ | status | in preparation | +-------------------+---------------------------------------------+ -| DOI | | +| DOI | `10.5281/zenodo.3774573`_ | | | | +-------------------+---------------------------------------------+ From fa9d36f93dc95f00f544d474601b02f51c48f9eb Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Fri, 1 May 2020 16:53:34 -0700 Subject: [PATCH 59/65] delete missed comma --- PLEP-0007.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 66af94b..614ae00 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -8,7 +8,7 @@ PLEP-0007 – Structure of Top-Level Sub-Packages | PLEP | 7 | +===================+=============================================+ | author(s) | | Erik T. Everson | -| | | Tulasi Parashar, | +| | | Tulasi Parashar | | | | Steve Vincena | | | | Nicholas A. Murphy | +-------------------+---------------------------------------------+ From 32f13ff35ce07d218e56e27d35616a306a538d5f Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Sun, 3 May 2020 12:34:04 -0700 Subject: [PATCH 60/65] steve -> stephen --- PLEP-0007.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 614ae00..608d3c7 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -9,7 +9,7 @@ PLEP-0007 – Structure of Top-Level Sub-Packages +===================+=============================================+ | author(s) | | Erik T. Everson | | | | Tulasi Parashar | -| | | Steve Vincena | +| | | Stephen Vincena | | | | Nicholas A. Murphy | +-------------------+---------------------------------------------+ | contact email | eeverson@ucla.edu | From 57ebe385b871aa876dcd6d7ce96c880c04e16db7 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Sun, 3 May 2020 12:38:58 -0700 Subject: [PATCH 61/65] add DOI to README --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index a61d022..1b2bedd 100644 --- a/README.rst +++ b/README.rst @@ -35,6 +35,6 @@ convenience, an abbreviated index of PLEPs is provided below. | 6 | `A New General-Purpose Plasma Object <./PLEP-0006.rst>`__ | .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1460977.svg | | | | :target: http://doi.org/10.5281/zenodo.1460977 | +--------+----------------------------------------------------------------------------------+--------------------------------------------------------------------+ -| 7 | `Structure of Top-Level Sub-Packages <./PLEP-0007.rst>`__ | | -| | | | +| 7 | `Structure of Top-Level Sub-Packages <./PLEP-0007.rst>`__ | .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3774573.svg | +| | | :target: http://doi.org/10.5281/zenodo.3774573 | +--------+----------------------------------------------------------------------------------+--------------------------------------------------------------------+ From f5e0df78416e45eadfad94d338809ff34e370ddc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Sta=C5=84czak?= Date: Tue, 12 May 2020 18:34:59 +0200 Subject: [PATCH 62/65] Typo fix Co-authored-by: Drew Leonard --- PLEP-0007.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 608d3c7..681b482 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -104,7 +104,7 @@ respective package PLEPs. | PLEP: | | +-----------------+-------------------------------------------------------------+ | scope: | | The ``addons`` sub-package is intended to be a plugin | -| | location to allow 3rd party users to extent the | +| | location to allow 3rd party users to extend the | | | capabilities of `PlasmaPy`_. | | | | | | | | `PlasmaPy`_'s primary goal is to provide common | From 0da36bbddf3445202416dbd6a4ef4ef04b1b9f52 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Tue, 12 May 2020 10:04:14 -0700 Subject: [PATCH 63/65] new code should be thoroughly and exhaustively reviewed before taking the step to amend this PLEP --- PLEP-0007.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 608d3c7..a74870f 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -54,9 +54,9 @@ structure should: #. help developers decided where new code should be placed #. help navigate users to the functionality they need -If new code does NOT fall within the current framework, then this PLEP -needs to be modified/updated accordingly before any new top-level -sub-packages are created. +If new code does NOT fall within the current framework after a thorough and +exhaustive review, then this PLEP needs to be modified/updated accordingly +before any new top-level sub-packages are created. Detailed Description ==================== From e7e907aa9ac04629465394fbd1c67a36aeba4098 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Tue, 12 May 2020 10:12:18 -0700 Subject: [PATCH 64/65] update last revised date and mark as accepted --- PLEP-0007.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 9a96bb7..59cfaf5 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -16,11 +16,11 @@ PLEP-0007 – Structure of Top-Level Sub-Packages +-------------------+---------------------------------------------+ | date created | 2019-10-27 | +-------------------+---------------------------------------------+ -| date last revised | 2020-05-01 | +| date last revised | 2020-05-12 | +-------------------+---------------------------------------------+ | type | standard | +-------------------+---------------------------------------------+ -| status | in preparation | +| status | Accepted | +-------------------+---------------------------------------------+ | DOI | `10.5281/zenodo.3774573`_ | | | | From aafbecb4e0fc376f411f31990bd0aa342e3def87 Mon Sep 17 00:00:00 2001 From: Erik Everson Date: Tue, 12 May 2020 10:14:52 -0700 Subject: [PATCH 65/65] capitalize Standard --- PLEP-0007.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PLEP-0007.rst b/PLEP-0007.rst index 59cfaf5..a89603f 100644 --- a/PLEP-0007.rst +++ b/PLEP-0007.rst @@ -18,7 +18,7 @@ PLEP-0007 – Structure of Top-Level Sub-Packages +-------------------+---------------------------------------------+ | date last revised | 2020-05-12 | +-------------------+---------------------------------------------+ -| type | standard | +| type | Standard | +-------------------+---------------------------------------------+ | status | Accepted | +-------------------+---------------------------------------------+