Documentation for plasmapy-addon-hello¶
About¶
The plasmapy-addon-hello package is setup to demonstrate how an independent
python distributions can extend the capabilities of
plasmapy.formulary.
Why does plasmapy need addon packages? Why are these extensions not included in the main plasmapy distribution? PlasmaPy sets out to provide a broad toolkit to support as many corners of plasma research and eduction as possible. A result of this, PlasmaPy focuses on providing the most commonly needed features for the community. With that said, we do see the benefit and need for specialized features like interface related to a certain research lab, analysis routines for a specific diagnostic, an interface to a simulation code, etc. These addon packages allow for these featrues to be independently developed, but still be accessilbe through plasmapy. PlasmaPy we develop some of these addon features, but we hope the community will also develop addons to make PlasmaPy more powerfull. This addon framework also allows for the main plasmapy distribution to stay “light-weight” and allow users to install the extra addon features they would like.
plasmapy_addon_hello Package¶
The plasmapy-add-hello package is an example demonstrating how to setup an independent (from PlasmaPy) distribution that extends the capabilities of PlasmaPy. This is done by utilizing the plasmapy.addons entry_points setup in the plasmapy package. To see the actually setting of the entry points look form the [options.entry_points] heading in this distributions `setup.cfg file <>`_.
Functions¶
hello(width) |
Print to screen the HELLO_STATEMENT. |
Variables¶
HELLO_STATEMENT |
plamapy-add-hello’s hello statement |
Index¶
Module Index¶
Table of Contents