sunpy / sunpy-1.0-paper

The SunPy 1.0 Paper Repo
12 stars 21 forks source link

Restructure introduction #133

Closed wtbarnes closed 5 years ago

wtbarnes commented 5 years ago

This PR is the result of work between myself and @mbobra. It restructures the introduction with a heavier focus on the strengths of Python and the scientific Python ecosystem.

@mbobra I ended up not including the bits about the benefits of open development because it seemed to make it a bit to long and I couldn't figure out how to fit it in. If you have an idea of how to work it in, please do!

ehsteve commented 5 years ago

I think this reads pretty well though I think that it is important that this be written and targeted specifically to solar. Your edit removed all of that. Right now this section would be equally applicable to biology or geology. The key points that I had in my text was about the size of the solar community, which is small, and therefore gains significantly more leverage by using already developed tools. As well as to remind readers about the past transition from Fortran to IDL. It's true that that section was probably long.

You could argue that my solar-specific points were not strong enough and I'd be happy to discuss other points but the key is that this has to be specific to our community and not generic.

wtbarnes commented 5 years ago

Fair point. I've added the Fortran/IDL discussion back in and adapted my changes appropriately. Let me know what you think. Reading it through, I don't actually think the length is really an issue.

mbobra commented 5 years ago

I think this is well-written and motivated -- thanks for working on this, @wtbarnes.

I personally do not think that a history about the transition from Fortran to IDL and then IDL to Python is relevant here for a few reasons:

As for @ehsteve's comment:

The key points that I had in my text was about the size of the solar community, which is small, and therefore gains significantly more leverage by using already developed tools.

It looks like @wtbarnes still has that information in the text:

Because the solar community is relatively small\footnote{For reference, out of the $\sim$9,500 members of the American Astronomy Society, approximately 500 are members of the society's Solar Physics Division.} in relation to other scientific communities, it stands to benefit immensely by utilizing the \python scientific stack to solve increasingly difficult scientific challenges and produce world-class science.

wtbarnes commented 5 years ago

Regarding the last point about the size of the solar community, I added that back in following @ehsteve's review. I had initially removed it, but I think it fits in well with the discussion of the scipy ecosystem.