PlasmaPy / PlasmaPy/plasmapy.github.io

List open source plasma physics packages

Open
#9 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

wish list
Dominant language
Python
Stars
17
Forks
24
PR merge metrics
No merged PRs in 30d

Description

In the words of the wise @namurphy,

That reminds me... It would be great to have a page on our website that lists other open source packages in plasma physics. I would really like to emphasize the open source packages that exist already.

We should make sure that the packages have an Open Source Initiative approved license, or at the very least meet their definition of open source.

The primary tools for this one: listing known plasma open source packages here, and google. Once we have a bunch, we'll add them to the website.

I'll go through my stars on GitHub tomorrow and add a bunch of those.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the linked Matrix discussion and the issue text to define the list's scope. Use Google and known GitHub stars to identify plasma physics packages, checking that each has an OSI-approved license or otherwise meets the stated open-source definition. Done means the qualifying packages are collected and ready to be added as a page on the website.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.