You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 8cd3655
Browse filesBrowse the repository at this point in the historyBrowse files
<p> The Astropy Project is a community effort to develop a core package for astronomy using the <ahref="http://www.python.org">Python programming language</a> and improve usability, interoperability, and collaboration between astronomy Python packages. The core <i>astropy</i> package contains functionality aimed at professional astronomers and astrophysicists, but may be useful to anyone developing astronomy software. The Astropy Project also includes "affiliated packages," Python packages that are not necessarily developed by the core development team, but share the goals of Astropy, and often build from the core package's code and infrastructure. </p>
53
+
<p> The Astropy Project is a community effort to develop a core package for astronomy using the <ahref="http://www.python.org">Python programming language</a> and improve usability, interoperability, and collaboration between astronomy Python packages. The core <i>astropy</i> package contains functionality aimed at professional astronomers and astrophysicists, but may be useful to anyone developing astronomy software. The Astropy Project also includes "affiliated packages," Python packages that are not necessarily developed by the core development team, but share the goals of Astropy, and often build from the core package's code and infrastructure. </p>
54
54
<p>For more details on the plan for the project, you can read the <ahref="http://docs.astropy.org/en/stable/overview.html">documentation overview</a>, or the <ahref="http://docs.astropy.org/en/stable/development/vision.html">original vision</a> from when the project was founded. </p>
55
55
56
56
</section>
@@ -62,7 +62,7 @@ <h2>Acknowledging or Citing Astropy</h2>
62
62
63
63
<h3>In Publications</h3>
64
64
65
-
<p>If you use Astropy for work/research presented in a publication (whether directly, or as a dependency to another package), we ask that you cite the <ahref="http://dx.doi.org/10.1051/0004-6361/201322068" target="_blank">Astropy Paper</a> (<ahref="http://adsabs.harvard.edu/abs/2013A%26A...558A..33A" target="_blank">ADS</a> -
65
+
<p>If you use Astropy for work/research presented in a publication (whether directly, or as a dependency to another package), we ask that you cite the <ahref="http://dx.doi.org/10.1051/0004-6361/201322068" target="_blank">Astropy Paper</a> (<ahref="http://adsabs.harvard.edu/abs/2013A%26A...558A..33A" target="_blank">ADS</a> -
We provide the following as a standard acknowledgment you can use if there is not a specific place to cite the paper:</p>
68
68
@@ -82,7 +82,7 @@ <h3>In Projects</h3>
82
82
83
83
<p>If you are using Astropy as part of a code project (e.g., affiliated packages), a useful way to acknowledge your use of Astropy is with a badge in your README. We suggest this badge: </p>
84
84
85
-
85
+
86
86
87
87
<imgsrc="http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat" alt="Powered by Astropy Badge"/>
88
88
@@ -217,7 +217,7 @@ <h3>Other Credits</h3>
217
217
<li>Andrew Pontzen and the <ahref="https://github.com/pynbody/pynbody" target="_blank">pynbody</a> team (For code that grew into astropy.units)</li>
218
218
<li>Everyone on <ahref="http://groups.google.com/group/astropy-dev" target="_blank">astropy-dev</a> and the <ahref="http://mail.scipy.org/mailman/listinfo/astropy" target="_blank">astropy mailing list</a> for contributing to many discussions and decisions!</li>
219
219
</ul>
220
-
<p>If you have contributed to the Astropy project and your name is missing,
220
+
<p>If you have contributed to the Astropy project and your name is missing,
221
221
please send an email to the coordinators, or <ahref="https://github.com/astropy/astropy/edit/master/docs/credits.rst" target="_blank">open a pull request for the credits document</a> in the astropy repository.</p>
222
222
223
223
@@ -230,7 +230,7 @@ <h2>License</h2>
230
230
231
231
<p>Astropy is licensed under a <ahref="http://opensource.org/licenses/BSD-3-Clause">three-clause BSD license</a>. For details, see the <ahref="https://github.com/astropy/astropy/blob/master/licenses/LICENSE.rst" target="_blank">licenses/LICENSE.rst</a> file in the astropy repository.</p>
If you use Astropy directly - or as a dependency to another package - for your work, please remember to include the following acknowledgment at the end of papers:
106
+
If you use Astropy directly - or as a dependency to another package - for your work, please remember to include the following acknowledgment at the end of papers:
107
107
</p>
108
108
<pclass="citation"><cite>This research made use of Astropy, a community-developed core Python package for Astronomy (Astropy Collaboration, 2013).</cite></p>
109
109
110
-
<p>where <cite>(Astropy Collaboration, 2013)</cite> is a citation to the <ahref="http://dx.doi.org/10.1051/0004-6361/201322068" target="_blank">Astropy Paper</a> (<ahref="http://adsabs.harvard.edu/abs/2013A%26A...558A..33A" target="_blank">ADS</a> -
110
+
<p>where <cite>(Astropy Collaboration, 2013)</cite> is a citation to the <ahref="http://dx.doi.org/10.1051/0004-6361/201322068" target="_blank">Astropy Paper</a> (<ahref="http://adsabs.harvard.edu/abs/2013A%26A...558A..33A" target="_blank">ADS</a> -
community-developed core Python package for Astronomy (Astropy Collaboration,
127
127
2013).</cite></p>
128
128
129
-
<p>where <cite>(Astropy Collaboration, 2013)</cite> is a citation to the <ahref="http://dx.doi.org/10.1051/0004-6361/201322068" target="_blank">Astropy Paper</a> (<ahref="http://adsabs.harvard.edu/abs/2013A%26A...558A..33A" target="_blank">ADS</a> -
129
+
<p>where <cite>(Astropy Collaboration, 2013)</cite> is a citation to the <ahref="http://dx.doi.org/10.1051/0004-6361/201322068" target="_blank">Astropy Paper</a> (<ahref="http://adsabs.harvard.edu/abs/2013A%26A...558A..33A" target="_blank">ADS</a> -
<p>If you are interested in contributing fixes, code or documentation to Astropy (whether the core package or affiliated packages), you should join the <ahref="http://groups.google.com/group/astropy-dev">astropy-dev</a> mailing list/forum, and start looking at any related <ahref="https://github.com/astropy/astropy/issues">issues</a>. You may also want to familiarize yourself with the <ahref="http://docs.astropy.org/en/latest/#developer-documentation" target="_blank">developer documentation</a>, particularly the <ahref="http://docs.astropy.org/en/latest/development/codeguide.html">coding</a> and <ahref="http://docs.astropy.org/en/latest/development/docguide.html">documentation</a> guidelines.</p>
72
-
73
-
<p> Once you have a change to propose, if it's a simple fix to just a single file, you can even just browse to the appropriate file and use the "edit" button on github. If it's a more complex change, we suggest you follow the <atarget="_blank" href="index.html#dev">developer install instructions</a>, and use that with <ahref="https://github.com/astropy/astropy">Astropy's github page</a> to issue a pull request with your changes. If you aren't familiar with github, we suggest you looking over our <ahref="http://astropy.readthedocs.org/en/latest/development/workflow/development_workflow.html">workflow documentation</a>. Once your code is accepted, you are officially an Astropy contributor and eligible to be included on the author list of future publications. </p>
71
+
<p>If you are interested in contributing fixes, code or documentation to Astropy (whether the core package or affiliated packages), you should join the <ahref="http://groups.google.com/group/astropy-dev">astropy-dev</a> mailing list/forum, and start looking at any related <ahref="https://github.com/astropy/astropy/issues">issues</a>. You may also want to familiarize yourself with the <ahref="http://docs.astropy.org/en/latest/#developer-documentation" target="_blank">developer documentation</a>, particularly the <ahref="http://docs.astropy.org/en/latest/development/codeguide.html">coding</a> and <ahref="http://docs.astropy.org/en/latest/development/docguide.html">documentation</a> guidelines.</p>
72
+
73
+
<p> Once you have a change to propose, if it's a simple fix to just a single file, you can even just browse to the appropriate file and use the "edit" button on github. If it's a more complex change, we suggest you follow the <atarget="_blank" href="index.html#dev">developer install instructions</a>, and use that with <ahref="https://github.com/astropy/astropy">Astropy's github page</a> to issue a pull request with your changes. If you aren't familiar with github, we suggest you looking over our <ahref="http://astropy.readthedocs.org/en/latest/development/workflow/development_workflow.html">workflow documentation</a>. Once your code is accepted, you are officially an Astropy contributor and eligible to be included on the author list of future publications. </p>
74
74
75
75
<p> If you want to propose a larger change to Astropy, there's a procedure for that: <ahref="https://github.com/astropy/astropy-APEs">Astropy Proposals for Enhancement (APEs)</a> (modeled after Python's <ahref="http://legacy.python.org/dev/peps/">PEPs</a>). The sort of changes that APEs are intended for include plans for new sub-packages, wide-ranging code re-organizations, a new procedure needing review by a lot of the Astropy community, or an informational document on some decision for Astropy that you want remembered. For more background on APEs, check out <ahref="https://github.com/astropy/astropy-APEs/blob/master/APE1.rst">APE #1</a> and the <ahref="https://github.com/astropy/astropy-APEs/blob/master/README.rst">APE repository's README</a>. There is also a <ahref="https://github.com/astropy/astropy/wiki/APE-Overview">wiki page on Astropy's github repository</a> that has an overview of the existing APEs.</p>
76
76
77
-
77
+
78
78
</section>
79
79
80
80
<sectionid="affiliated">
81
81
<h2>Develop an affiliated package</h2>
82
82
83
83
<p>Whether you have an idea for a new Astronomy package, or already have a package that you want to integrate with the Astropy project, you can develop an affiliated package! You'll want to join the <ahref="http://groups.google.com/group/astropy-dev">astropy-dev</a> list so you can notifying other developers of your intent to develop an affiliated package. Then you can check out the <ahref="affiliated/index.html#affiliated-instructions">affiliated package guidelines</a> and the <ahref="http://github.com/astropy/package-template">template for new affiliated packages</a> to get started. We can even create a repository for your affiliated package in the astropy organization on GitHub, if you ask on the mailing list!</p>
0 commit comments