Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better describe the goal, target audience of the project #31

Closed
StanczakDominik opened this issue May 17, 2020 · 5 comments · Fixed by #34
Closed

Better describe the goal, target audience of the project #31

StanczakDominik opened this issue May 17, 2020 · 5 comments · Fixed by #34

Comments

@StanczakDominik
Copy link
Contributor

Hey, I'm getting back to reviewing the project (sorry for the delay!). I got to this point:

A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?

And in the documentation and README I can see only

VlaPy is a 1-spatial-dimension, 1-velocity-dimension, Vlasov-Poisson-Fokker-Planck code written in Python. The Vlasov-Poisson-Fokker-Planck system of equations is commonly used in plasma physics.

I think this could be expanded a little. The goal is stated pretty clearly, but the target audience is not mentioned, except very broadly (plasma physicists).

@joglekara
Copy link
Owner

Thanks for the feedback. Will expand on that a bit more.

@StanczakDominik
Copy link
Contributor Author

I just got to the actual paper, and the section in there sounds good :)

@joglekara
Copy link
Owner

Ah, thanks!

In that case, should we close this?

Or do you believe I should add that to the README as well? It doesn't seem like most repositories do that but I'm happy to be proven wrong!

@StanczakDominik
Copy link
Contributor Author

I think it'd make sense for it to be in the readme as well. That's the first place someone stumbling upon a project looks at.

@joglekara
Copy link
Owner

Okay, sounds good. Take a look at #34

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants