Skip to content
This repository has been archived by the owner on May 17, 2021. It is now read-only.

Commit

Permalink
Merge pull request #155 from wafels/master
Browse files Browse the repository at this point in the history
Minor edits
  • Loading branch information
ehsteve authored Aug 23, 2019
2 parents 0e31142 + ca7d65a commit 7ccebab
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion sections/1-introduction.tex
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ \section{Introduction}
This paper describes the first stable release (version 1.0) of the \sunpypkg core package.
A previous paper describes version 0.5 \citep{Community:2015cy}.
This article is not meant to replace the \sunpypkg documentation but provides an overview of the organization and highlights important functionality.
The full text of the paper, including all of the code to produce the figures, is available in a \github repository\footnote{\url{https://github.com/sunpy/sunpy-1.0-paper}}.
The full text of the paper, including all of the code to produce the figures, is available in a \github\, repository\footnote{\url{https://github.com/sunpy/sunpy-1.0-paper}}.
2 changes: 1 addition & 1 deletion sections/10-community.tex
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ \section{Community}
Additionally, we maintain a number of active communication channels including mailing lists, real-time chats based on the open source Matrix protocol\footnote{\url{https://matrix.org}}, and weekly teleconferences.
SunPy community members have also lead tutorials at national and international conferences, participated in summer programs, and provided mentorship to new members of the community.
Developers and contributors are currently provided credit for their work by authorship on papers, posters, and release notes, as well as awards.
For example, in 2018, Vishnunarayan K. I. was presented an award by NumFOCUS for exceptional contributions to the open source scientific software ecosystem by updating \sunpypkg to use a scientific time class.
For example, in 2018, Vishnunarayan K. I. was presented an award by NumFOCUS for exceptional contributions to the open source scientific software ecosystem by updating \sunpypkg to use \package{astropy.time}.
2 changes: 1 addition & 1 deletion sections/13-acknowledgements.tex
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
\acknowledgments

We thank the members of the community that have contributed to the \sunpyproj, that have opened issues and provided feedback, and have supported the project in a number of other ways.
Additionally, we thank Brian Dennis, Richard Schwartz, and Bill Thompson whose comments greatly improved this manuscript.
Additionally, we thank Brian Dennis, Richard Schwartz, and William Thompson whose comments greatly improved this manuscript.

The following individuals recognize support for their personal contributions.
BMS is supported by the NSF grant AST-1715122 and acknowledges support from the DIRAC Institute in the Department of Astronomy at the University of Washington.
Expand Down
4 changes: 2 additions & 2 deletions sections/4-development.tex
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ \section{Development Model}
\label{sec:development}

To satisfy the mission of the Project, the SunPy community adopted an open development model, which is widely used within the scientific \python community.
The \sunpypkg package is hosted on \github and uses \code{git}\footnote{\url{https://git-scm.com/}} as its distributed version control software.
The \sunpypkg package is hosted on \github\, and uses \code{git}\footnote{\url{https://git-scm.com/}} as its distributed version control software.
The entire code base is publicly available and anyone can suggest changes through pull requests.
Since the code base is licensed under a permissive 2-clause BSD license\footnote{\url{https://opensource.org/licenses/BSD-2-Clause}}, anyone can redistribute, improve, repackage or use it in a closed environment as long as they credit the SunPy developers and redistribute the license.
In order to maintain high-quality code, every contribution is reviewed and must satisfy the following requirements:
Expand All @@ -23,7 +23,7 @@ \section{Development Model}
The total number of contributors is large for a package of this size in the heliophysics community \citep{pyhc2018}.

The rightmost panel of \autoref{fig:metafig} shows the distribution of the total number of commits per contributor as of June 2019.
The distribution is relatively steep with a log-log slope of $-0.34$, which indicates that relatively few contributors generate the majority of commits.
The distribution is relatively steep with a log-log slope of $-0.35$, which indicates that relatively few contributors generate the majority of commits.
The top 10 contributors are responsible for ${\sim}80\%$ of all commits.
This compares poorly to other projects such as \astropy \citep{astropy2018}.
Unlike \astropy, the \sunpyproj was not formed to bring together and coordinate many existing developers and their \python packages.
Expand Down
2 changes: 1 addition & 1 deletion sections/4a-sunpy-net.tex
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ \subsubsection{The \Fido Interface}

The most powerful component of \package{sunpy.net} is the \Fido interface for data search and retrieval.
\Fido provides a unified interface that simplifies and homogenizes search and retrieval by allowing data to be queried and downloaded from multiple data sources simultaneously, irrespective of the underlying client.
Currently, \Fido supports the Virtual Solar Observatory \citep[VSO,][]{2009EM&P..104..315H}, the Joint Science Operations Center (JSOC, see \autoref{sec:drms}), and a number of individual data providers that make their data available via web-accessible resources such as HTTP websites (RHESSI, SDO EVE, GOES XRS, PROBA2 LYRA, and NOAA sunspot number prediction) and FTP servers (NOAA sunspot number, NoRH).
Currently, \Fido supports the Virtual Solar Observatory \citep[VSO,][]{2009EM&P..104..315H}, the Joint Science Operations Center (JSOC, see \autoref{sec:drms}), and a number of individual data providers that make their data available via web-accessible resources such as HTTP(S) websites (RHESSI, SDO EVE, GOES XRS, PROBA2 LYRA, and NOAA sunspot number prediction) and FTP servers (NOAA sunspot number, NoRH).

A \Fido search accesses multiple instruments and all available data providers in a single query.
Search queries optionally include a variety of attributes, such as instrument, time range, and wavelength.
Expand Down
3 changes: 2 additions & 1 deletion sections/5-modules.tex
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,8 @@ \subsubsection{\Map}
The left panel shows the full field of view of AIA using the appropriate color table and scaling for the observation, and the right panel shows a cropped view highlighting a solar flare whose GOES XRS light curve is shown in \autoref{fig:timeseries_example}.

When analyzing the dynamics of features on the solar disk, it is important to account for variations due to the apparent rotation of the Sun, which includes solar differential rotation, a latitudinally-varying rotation rate due to the non-rigidity of the solar interior \citep[see][]{Beck2000}.
The \package{sunpy.physics.differential\_rotation} subpackage provides the ability for a \Map to be transformed to a future time including the effect of solar differential rotation (see \autoref{fig:diff_rot}).
The \package{sunpy.physics.differential\_rotation} subpackage provides
the ability for a \Map to be transformed to earlier or future times including the effect of solar differential rotation (see \autoref{fig:diff_rot}).

\begin{figure}
\centering
Expand Down

0 comments on commit 7ccebab

Please sign in to comment.