PLEP7: top level package structure #26

rocco8773 · 2019-10-29T03:17:08Z

This PLEP is focused on:

Defining the top-level sub-package namespace for PlasmaPy
Defining the general scope of each top-level sub-package

The goal is to:

Keep the top-level namespace of PlasmaPy from getting bloated
Help guide developers/contributes on where to place their code

This PLEP was initially outlined by the PlasmaPy Coordinating Team at the 2019 61st APS-DPP Meeting.

P.S. I will remove the "draft" label when I'm satisfied with the PLEP and ready to merge it.

Still need to...

Start Zenodo upload to reserve DOI (https://doi.org/10.5281/zenodo.3774573)
Publish to Zenodo
Update ./README.rst with DOI
Update PLEP DOI field
Update PLEP date last revised field with accepted date
Update PLEP status field with accepted when accepted
Update linked PRs under section Issues, Pull Requests, and Branches when PRs are merged (see issue Update PLEP7 with PR and Issue links #32, the PLEP will be updated with links once the implementation is complete)

…el packages, details are left to package focused PLEPs

I assumed you didn't actually want to change `plasmapy.simulation` to `plasmapy.simulations` plural, so I reverted that.

PLEP-0007.rst

StanczakDominik · 2019-10-29T04:42:13Z

I went ahead and did a few initial comments, and oh dear, the tables broke them 😆 The Files Changed view will be a better choice for viewing them.

… into PLEP7_top_level_package_structure

…pport multicolumn

This reverts commit 3ab4e72

…T content directive...arggg

SolarDrew

LGTM bar a few minor comments 👍 Thanks for all your work on this @rocco8773 et al

SolarDrew · 2020-05-12T15:47:52Z

PLEP-0007.rst

+
+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.


Or, presumably, the code should be ajusted to fit this framework?

I've reworded this a bit to indicate that amending the PLEP should be the last resort option. I assumed that would happen by default, since it will always be easier to conform code than to amend the PLEP and get it accepted.

This statement is here more so for the off chance that we overlooked something that should be a top-level package.

PLEP-0007.rst

SolarDrew · 2020-05-12T15:56:04Z

PLEP-0007.rst

+-----------------+-------------------------------------------------------------+
+| scope:          | | A collection of tests for top-level modules (i.e.         |
+|                 |   functions and classes defined in top-level ``.py``        |
+|                 |   files).                                                   |


Surely we also want to test functions and classes defined in subfolders of these modules?

I thought folders of .py files were subpackages, and if that's the case, the current wording makes sense - there's no other place to put tests for .py files in the main plasmapy directory.

In the python lingo, .py files are modules and folders are sub-packages.

@SolarDrew Yes, sub-package tests should still be done within their respective directory.

Think of this as a place for testing the interplay of various sub-packages. Will using dispersion capability in simulation break anything? Will using formulary inside analysis break anything?

Co-authored-by: Drew Leonard <[email protected]>

… the step to amend this PLEP

… into PLEP7_top_level_package_structure

PLEP-0007.rst

namurphy · 2020-05-13T23:30:44Z

PLEP-0007.rst

+**Contents**
+
+* `Abstract`_
+* `Detailed Description`_
+
+  * `Why?`_
+  * `Top-Level Sub-Packages`_
+
+* `Extensible Packages are Exempt`_
+* `Implementation`_
+* `Issues, Pull Requests, and Branches`_
+* `Backward Compatibility`_
+* `Decision Rationale`_


As an aside, maybe we should add a table of contents to the PLEP template. That way, future PLEP writers would have a draft table of contents ready.

rocco8773 and others added 19 commits October 27, 2019 14:00

initial commit for PLEP-0007...fill-out summary and abstract

9fb6cfb

start outlining Detailed Description

1382c2c

testing a table

80d256c

testing a table design

94d4336

testing a table design

676c6d9

testing a line blocks in table design

dd1af5b

testing a line blocks in table design

5c55600

place all sup-packages into table

ddbc634

add Tulasi Parashar, Steve Vincena, and Nick Murphy to authors

a501334

defining scope of plasmapy.utils

637ba4e

defining scope of plasmapy.tests

930e0fc

defining scope of plasmapy.simulations

2855a77

testing :additional PLEP: look

9d084ad

add to abstract...this PLEP only defines the general scope of top-lev…

d3b3d80

…el packages, details are left to package focused PLEPs

add :sub-package PLEP: entry to each sub-package

c6265c1

remove bullet point list

32d3681

defining scope of plasmapy.formulary

5a15ce4

defining scope of plasmapy.analysis

ada2eeb

add `` to get proper inline code typesetting

a0389c7

rocco8773 added Status: In preparation Type: Standard labels Oct 29, 2019

rocco8773 self-assigned this Oct 29, 2019

rocco8773 requested review from namurphy and tulasinandan October 29, 2019 03:17

Fix a few typos

2aa0677

I assumed you didn't actually want to change `plasmapy.simulation` to `plasmapy.simulations` plural, so I reverted that.

StanczakDominik reviewed Oct 29, 2019

View reviewed changes

PLEP-0007.rst Outdated Show resolved Hide resolved

PLEP-0007.rst Outdated Show resolved Hide resolved

rocco8773 added 3 commits October 29, 2019 09:19

add scope to plasmapy.particle

792292a

Merge remote-tracking branch 'fork/PLEP7_top_level_package_structure'…

7b2f447

… into PLEP7_top_level_package_structure

add scope to plasmapy.dispersion

0bf60ba

namurphy approved these changes Apr 30, 2020

View reviewed changes

rocco8773 added 6 commits April 30, 2020 16:21

reformat tables so they look good as rst and pdf...pandoc does not su…

e92d515

…pport multicolumn

how do section look vs table headings

3ab4e72

Revert "how do section look vs table headings"

0dcafe4

This reverts commit 3ab4e72

add clause about exempting extensible packages

0b3be4f

manually add a table of contents since pandoc does not support the RS…

a2c5049

…T content directive...arggg

reduce wordiness

f794536

StanczakDominik approved these changes May 1, 2020

View reviewed changes

namurphy mentioned this pull request May 1, 2020

Release version 0.4.0 PlasmaPy/PlasmaPy#795

Closed

5 tasks

rocco8773 added 3 commits May 1, 2020 16:52

add DOI and last revised date

46b043c

delete missed comma

fa9d36f

steve -> stephen

32f13ff

rocco8773 mentioned this pull request May 3, 2020

Update PLEP-0 when PLEP-7 is accepted #30

Open

add DOI to README

57ebe38

rocco8773 added Status: Implemented Status: Voting PLEP pull requests that are being voted upon and removed Status: In preparation labels May 3, 2020

namurphy approved these changes May 3, 2020

View reviewed changes

StanczakDominik approved these changes May 4, 2020

View reviewed changes

SolarDrew approved these changes May 12, 2020

View reviewed changes

StanczakDominik and others added 5 commits May 12, 2020 18:34

Typo fix

f5e0df7

Co-authored-by: Drew Leonard <[email protected]>

new code should be thoroughly and exhaustively reviewed before taking…

0da36bb

… the step to amend this PLEP

Merge remote-tracking branch 'fork/PLEP7_top_level_package_structure'…

d049a44

… into PLEP7_top_level_package_structure

update last revised date and mark as accepted

e7e907a

capitalize Standard

aafbecb

tulasinandan reviewed May 13, 2020

View reviewed changes

PLEP-0007.rst Show resolved Hide resolved

tulasinandan approved these changes May 13, 2020

View reviewed changes

namurphy approved these changes May 13, 2020

View reviewed changes

rocco8773 merged commit bd1bc1e into PlasmaPy:master May 15, 2020

rocco8773 mentioned this pull request Jun 23, 2020

Add PLEP7 author to convert_to_pdf.sh #33

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PLEP7: top level package structure #26

PLEP7: top level package structure #26

rocco8773 commented Oct 29, 2019 •

edited

Loading

StanczakDominik commented Oct 29, 2019

SolarDrew left a comment

SolarDrew May 12, 2020

rocco8773 May 12, 2020

SolarDrew May 12, 2020

StanczakDominik May 12, 2020

rocco8773 May 12, 2020

tulasinandan May 13, 2020

namurphy May 13, 2020

PLEP7: top level package structure #26

PLEP7: top level package structure #26

Conversation

rocco8773 commented Oct 29, 2019 • edited Loading

Still need to...

StanczakDominik commented Oct 29, 2019

SolarDrew left a comment

Choose a reason for hiding this comment

SolarDrew May 12, 2020

Choose a reason for hiding this comment

rocco8773 May 12, 2020

Choose a reason for hiding this comment

SolarDrew May 12, 2020

Choose a reason for hiding this comment

StanczakDominik May 12, 2020

Choose a reason for hiding this comment

rocco8773 May 12, 2020

Choose a reason for hiding this comment

tulasinandan May 13, 2020

Choose a reason for hiding this comment

namurphy May 13, 2020

Choose a reason for hiding this comment

rocco8773 commented Oct 29, 2019 •

edited

Loading