Comments (6)
Oh...I forgot to say that it is no problem at all to set up new packages through the PlasmaPy organization on GitHub. We already have one set up for PlasmaPy Enhancement Proposals though nothing is yet there.
from plasmapy.
This reddit comment is quite pertinent. ! Using sub-packages would allow users to use any small tools the way they want.
However, I'm not sure to understand the subtle difference between module and package. I thought any collection of python files was a package... On my opinion this question is more about the code architecture, isn't it ?
Or is it about providing a lot of little tools instead of few macro functions ?
(I'm sorry if I sound dump, I'm quite a newbie in project development ^^)
from plasmapy.
I'm inclined to agree with @antoinelpp. I don't really see much of a useful distinction between calling it a module or a package, though I'm happy to be educated on that if I'm just being ignorant.
I do think that structuring it as a number of fairly self-contained sub-modules/sub-packages (following the astropy model again) does make sense, so I'm happy to do that to the extent that it's useful for us.
from plasmapy.
Oh yeah, I did misspeak there. I intended to say that a system of sub-packages for organization would be neat. As it stands, we've got three main branches: analytic functions, atomic data (the two I of which I think could be gathered into a single knowledge about plasmas
package for which I lack a name), and then there's simulation
which currently seems to be branching into PIC
and MHD
. Would that be a reasonable set of packages?
I suppose we could also use a schematic for how the package is organized, I'll try to whip something up with graphviz.
Oh yeah, I just noticed this is a duplicate of #51. Sorry, I was in a rush to type down the recent issues raised.
from plasmapy.
I am a big fan of the Astropy model where there's the core Astropy package with the functionality needed by most plasma physicists and then a long list of affiliated packages with more specialized functionality.
I am wondering if we should keep simulation
as a subpackage within the core PlasmaPy package because it would contain functionality that would probably be needed in several specialized packages.
I had to look it up, but it appears that a module is what's contained in a single .py
file, while a package is a collection of .py
files organized into some hierarchical structure. Learn something new every day!
from plasmapy.
from plasmapy.
Related Issues (20)
- Improve Thomson module
- Different return types for `is_category` method of `ParticleList` than `Particle` & `CustomParticle` HOT 3
- Make it so that mypy thinks that `ParticleLike` has the same attributes as `Particle`
- Store downloaded data in `$XDG_DATA_HOME` if that environment variable exists HOT 1
- Multiple density values in `formulary.radiation.thermal_bremsstrahlung` returns `ValueError`
- `thomson_fitting` error with `lmfit==1.3.0` HOT 3
- Make it so that `plasmapy.__version__` uses current date in editable installs
- Verify that files are included or not included in source distributions and wheels
- Show correct version in title of `latest` docs
- Enable weekly tests with the JIT compiler to be added in Python 3.13
- CI codecov bug HOT 2
- Allow ParticleTracker to accept analytical fields (as functions) or lists of currents/charges
- Add helper functionality to plot quantities against temperature with axes labeled in both K and eV HOT 2
- Add `latex_str` attribute to `Particle`
- Add Jupyter notebook that plots reconnection phase diagram
- what is the unit of temperature defined in the Spitzer resistivity HOT 1
- Requirements files need to be rethought HOT 2
- Spin off plasma calculator into separate affiliated package
- Rename `binding_energy` property of `Particle` to `nuclear_binding_energy` and add `electron_binding_energy` based on `ionization_energy`
- Add a Nox session to build the changelog
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from plasmapy.