' + _('Hide Search Matches') + '
') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) == 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this == '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/_static/down-pressed.png b/_static/down-pressed.png new file mode 100644 index 00000000..6f7ad782 Binary files /dev/null and b/_static/down-pressed.png differ diff --git a/_static/down.png b/_static/down.png new file mode 100644 index 00000000..3003a887 Binary files /dev/null and b/_static/down.png differ diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 00000000..d18082e3 Binary files /dev/null and b/_static/file.png differ diff --git a/_static/fork_me_on_github.png b/_static/fork_me_on_github.png new file mode 100644 index 00000000..7dc1afca Binary files /dev/null and b/_static/fork_me_on_github.png differ diff --git a/_static/jquery.js b/_static/jquery.js new file mode 100644 index 00000000..7c243080 --- /dev/null +++ b/_static/jquery.js @@ -0,0 +1,154 @@ +/*! + * jQuery JavaScript Library v1.4.2 + * http://jquery.com/ + * + * Copyright 2010, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2010, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Sat Feb 13 22:33:48 2010 -0500 + */ +(function(A,w){function ma(){if(!c.isReady){try{s.documentElement.doScroll("left")}catch(a){setTimeout(ma,1);return}c.ready()}}function Qa(a,b){b.src?c.ajax({url:b.src,async:false,dataType:"script"}):c.globalEval(b.text||b.textContent||b.innerHTML||"");b.parentNode&&b.parentNode.removeChild(b)}function X(a,b,d,f,e,j){var i=a.length;if(typeof b==="object"){for(var o in b)X(a,o,b[o],f,e,d);return a}if(d!==w){f=!j&&f&&c.isFunction(d);for(o=0;o","
"];c.fn.extend({text:function(a){if(c.isFunction(a))return this.each(function(b){var d=
+c(this);d.text(a.call(this,b,d.text()))});if(typeof a!=="object"&&a!==w)return this.empty().append((this[0]&&this[0].ownerDocument||s).createTextNode(a));return c.text(this)},wrapAll:function(a){if(c.isFunction(a))return this.each(function(d){c(this).wrapAll(a.call(this,d))});if(this[0]){var b=c(a,this[0].ownerDocument).eq(0).clone(true);this[0].parentNode&&b.insertBefore(this[0]);b.map(function(){for(var d=this;d.firstChild&&d.firstChild.nodeType===1;)d=d.firstChild;return d}).append(this)}return this},
+wrapInner:function(a){if(c.isFunction(a))return this.each(function(b){c(this).wrapInner(a.call(this,b))});return this.each(function(){var b=c(this),d=b.contents();d.length?d.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){c(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){c.nodeName(this,"body")||c(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.appendChild(a)})},
+prepend:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,this)});else if(arguments.length){var a=c(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,
+this.nextSibling)});else if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,c(arguments[0]).toArray());return a}},remove:function(a,b){for(var d=0,f;(f=this[d])!=null;d++)if(!a||c.filter(a,[f]).length){if(!b&&f.nodeType===1){c.cleanData(f.getElementsByTagName("*"));c.cleanData([f])}f.parentNode&&f.parentNode.removeChild(f)}return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++)for(b.nodeType===1&&c.cleanData(b.getElementsByTagName("*"));b.firstChild;)b.removeChild(b.firstChild);
+return this},clone:function(a){var b=this.map(function(){if(!c.support.noCloneEvent&&!c.isXMLDoc(this)){var d=this.outerHTML,f=this.ownerDocument;if(!d){d=f.createElement("div");d.appendChild(this.cloneNode(true));d=d.innerHTML}return c.clean([d.replace(Ja,"").replace(/=([^="'>\s]+\/)>/g,'="$1">').replace(V,"")],f)[0]}else return this.cloneNode(true)});if(a===true){ra(this,b);ra(this.find("*"),b.find("*"))}return b},html:function(a){if(a===w)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(Ja,
+""):null;else if(typeof a==="string"&&!ta.test(a)&&(c.support.leadingWhitespace||!V.test(a))&&!F[(La.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Ka,Ma);try{for(var b=0,d=this.length;b' + _('Searching') + '
').appendTo(this.out); + this.dots = $('').appendTo(this.title); + this.status = $('').appendTo(this.out); + this.output = $('\
+ \
+
\
+ ';
+
+ var replyTemplate = '\
+ \
+
\
+ \
+ \ + <%username%>\ + \ + <%time.delta%>\ +
\ +<#text#>
\
+ \ + \ + reply ▿\ + proposal ▹\ + \ + \ + \ +
\ +\ +<#proposal_diff#>\ +\ +
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 
-
-
-
-
-
-
-
-
-
diff --git a/acknowledging.html b/acknowledging.html
deleted file mode 100755
index b63e3dcb..00000000
--- a/acknowledging.html
+++ /dev/null
@@ -1,287 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-About The Astropy Project¶
- -The Astropy Project is a community effort to develop a core package - for astronomy using the - Python programming language - and improve usability, interoperability, and collaboration between astronomy - Python packages. The core astropy 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.
- -Aside from the actual code, Astropy is also a community of astronomy- - associated users and developers that agree that sharing utilities is - healthy for the community and the science it produces. This community is - of course central to accomplishing anything with the code itself. - We welcome anyone who - wishes to contribute to the project and expect everyone in our community - to follow the code of conduct when interacting with others.
- -For more details on background of the project, you can read the - original vision - from when the project was founded.
-astropy Core Package¶
- -The astropy package (alternatively known as the "core" package) - contains various classes, utilities, and a packaging framework intended - to provide commonly-used astronomy tools. It is divided into a variety - of sub-packages, which are described in detail in the - documentation.
-Affiliated Packages¶
- -The Astropy project includes the concept of "affiliated packages." An - affiliated package is an astronomy-related python package that is not - part of the astropy core source code, but has requested to be included - in the general community effort of the Astropy project. Such a package - may be a candidate for eventual inclusion in the main astropy package - (although this is not required). Until then, however, it is a separate - package, and may not be in the astropy namespace.
- -The authoritative listing of current affiliated packages is available at - http://affiliated.astropy.org. - That page also describes the process to get a package listed as an affiliated package.
-License¶
- -Astropy is licensed under a three-clause BSD license. For details, see the LICENSE.rst file in the astropy repository.
-Governance¶
-Astropy governance is as laid out in APE 0, consisting of the Coordination Committee, the Ombudsperson, and the Voting Members. Accompanying policies are documented in the project policies folder.
-Fiscal Sponsor¶
- -Astropy is a Sponsored Project of NumFOCUS, a 501(c)(3) nonprofit charity in the United States. - NumFOCUS provides Astropy with fiscal, legal, and administrative support to help ensure the health and sustainability of the project. - Visit numfocus.org for more information.
- -
-
-
-
-
-
-
-
-
- -
-
-
- -
-
-
-
-
-
-
-
-
-
diff --git a/affiliated/index.html b/affiliated/index.html
index 8f91774f..9f179a88 100644
--- a/affiliated/index.html
+++ b/affiliated/index.html
@@ -1,474 +1,446 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-Acknowledging or Citing Astropy¶
- -In Publications
- -If you use Astropy Project tools and resources for work/research presented in a - publication (whether directly, or as a dependency to another package), we ask that you - please cite the Astropy papers. We encourage you to cite all three papers, but if space - is limited, please cite the most recent paper: -
-
-
- Astropy Paper III (v5.0) - (ADS - - BibTeX) - -
- Astropy Paper II (v2.0) - (ADS - - BibTeX) - -
- Astropy Paper I (v0.2) - (ADS - - BibTeX - 10k citations) - -
- If you are using AASTeX and plan to submit an article to one of the AAS journals, we recommend adding a \software{...} tag to your manuscript that cites Astropy (see the AASTeX guide for more information), e.g.: -
- -- - \software{Astropy \citep{astropy:2013, astropy:2018, astropy:2022}} - -
- -- (but please also consider adding and citing other software packages that you use to this list as well). -
- -- If you are submitting an article to another journal, or have no other specific place in your manuscript to cite the papers, we provide the following LaTeX/BibTeX snippet to add to your acknowledgments: -
- -- This work made use of Astropy:\footnote{http://www.astropy.org} a community-developed core Python package and an - ecosystem of tools and resources for astronomy \citep{astropy:2013, astropy:2018, astropy:2022}. - -
- -- As an alternative, the BibTeX record recommended for a given version of Astropy is available from the Python package itself: -
-import astropy -astropy.__citation__- - -
- -
In Presentations
- -If you are giving a presentation or talk featuring work/research that makes use of Astropy and would like to acknowledge Astropy, we suggest using this logo on your title slide:
- -
-
- The logo is also available with white text, or the SVG originals can be obtained at the astropy-logo github repository.
- -
- -
In Projects
- -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:
- -
-
- Which is available at the URL http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat. If your code is hosted on github, You can place the following in your README.md file to get the badge:
- - - [](http://www.astropy.org/) - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Astropy Affiliated Packages¶
- -A major part of the Astropy Project is the concept of “Astropy - affiliated packages”. An affiliated package is an astronomy-related Python - package that is not part of the astropy core package, and is not managed by - the project but is a part of the Astropy Project community. These packages - demonstrate a commitment to Astropy’s goals of improving reuse, - interoperability, and interface standards for Python astronomy and - astrophysics packages. In many (but not all) cases, affiliated packages - also follow similar development processes and package templates as for the - core package.
- -If you are a developer interested in signing up as an affiliated package, - details are in the Becoming an - Affiliated Package section.
- -Astropy Coordinated Packages¶
- -A related concept is that of “Astropy coordinated packages”. Coordinated - packages are similar to affiliated packages, but the Astropy Project as a - whole maintains them. In practice this means the Astropy coordination - committee has administrative control of a coordinated package repository - (delegated to the maintainers), and that maintainers of these packages have - formal roles in the Astropy Project. The most - prominent of these coordinated packages is the Astropy core package itself. - In some cases these are packages identified by the core team as needing - development separate from the core (either they are experimental or problem - space-focused), while others started as affiliated packages but have become - so important to the ecosystem that they grew to become coordinated.
- -Astropy Infrastructure Packages¶
- -One final related category are the "Astropy infrastructure packages". - These packages are those that are necessary infrastructure for Astropy - packages - e.g. testing and documentation machinery. While occasionally - these have astro-specific functionality, in general they are more generic - packages that are useful to packages outside of astronomy, and as a result - may have some maintainers outside the Astropy project. But some are also - Astropy coordinated packages, with maintainers drawn from the infrastructure - roles. -
- -Installing Affiliated and Coordinated Packages¶
- -All packages should be available on PyPI. Some are available via conda, particularly - through the conda-forge channel. That said, affiliated packages are developed - independently of the Astropy core library. You should refer to the package's - documentation first if you encounter problems.
- -Coordinated Packages¶
-The following table lists all current Astropy coordinated packages.
-Total number of coordinated packages:
- -| - | - | - | - | |
|---|---|---|---|---|
| Loading... | -- | - | - | - |
| - | - | |||
Affiliated Packages Registry¶
-The following table lists all currently registered affiliated packages.
-NOTE: The listing is currently minimal because Astropy has just accepted - APE 22 - in January 2024. We are in the midst of transitioning to the new process in - partnership with pyOpenSci, so we really appreciate your patience. -
- -Total number of post-APE 22 affiliated packages:
- -| - | - | - | - |
|---|---|---|---|
| - | - | ||
| - | - | ||
All accepted pyOpenSci packages available here.
- -All currently under review packages via pyOpenSci available here.
-Affiliated Packages Registry (Pre-APE 22)¶
- -This section contains the listing of Astropy Affiliated Packages that pre-dated - APE 22. -This section is frozen as of March 6, 2024.
- -Total number of pre-APE 22 affiliated packages:
- -| - | - | - | - | |
|---|---|---|---|---|
| Loading... | -- | - | - | - |
| - | - | |||
Becoming an Affiliated Package¶
- -Astropy uses the pyOpenSci peer review process - to vet affiliated packages. If you are a developer of an astronomy package and would like your package to become - affiliated with the Astropy Project, you submit your package directly to pyOpenSci. - Astropy will be involved in the review, which will allow your package to become an - affiliated package through that review process. You can also opt to be fast tracked through - JOSS if desired. Read the pyOpenSci author guide to learn - - how to get started with submitting a package to pyOpenSci through their affiliated partner program Guidebook. -
- -In addition to pyOpenSci criteria, we also apply - - Astropy-specific guidelines for reviewing affiliated packages. - This will give you a - sense of whether your package is ready for review. Broadly speaking, your - package should:
- --
-
-
- Comply with general pyOpenSci review standards. Please see Peer Review Guide for Python Open Source Authors for more details. - -
- Be potentially useful to astronomers. This can mean useful to a - specific sub-domain of astronomy, or more broadly useful to a large - fraction of astronomy (or beyond, as long as it is also useful for - astronomy). - -
- Specifically use, interface with, or provide complementary capabilities - to other Astropy packages. - -
- Use classes and functions from the - astropy core package wherever possible and appropriate, and (as much as - possible) avoid duplication with other packages in the Astropy ecosystem. - This facilitates re-use of code and sharing of resources. - -
- Be open to contributions from others. While this most straightforwardly - means it follows a Github-based open development model (like the Astropy core - package), alternative approaches are perfectly valid as long as they are - consistent with basic principles of open source; e.g., - an OSI-approved license. - -
- Include instructions to users on how to cite your package. This is commonly done - with a CITATION file. This file could include a Zenodo record (highly recommended), - acknowledgement text, and/or journal article(s). Where possible, full BibTeX entries of - these citations are recommended. - -
- Include citations to other relevant papers and software following - leading - practices for citing astronomy software. - -
In addition, you should make an effort to connect with the Astropy - developer community, including developers from the core astropy package or - any related affiliated packages. If your package is determined to meet the above - standards, it will be accepted and added to the affiliated package registry. - Note however that if packages become unmaintained or do not meet the standards - anymore, they may be removed from the list of affiliated packages, as per pyOpenSci policy.
- -Package Template¶
-If you are considering creating a new astronomy package and would like it - to be an Astropy affiliated package, you can use the OpenAstronomy packaging guide to - make it much easier to meet these standards. It reflects up-to-date Python packaging techniques - to generate documentation like that used in the astropy package, a - ready-to-use testing framework, and a variety of tools that streamline tasks - like user configuration, caching downloaded files, or linking C-compiled - extensions. More details on this template are available in the usage - instructions for the template. -
- -Additionally, it is also acceptable to use -pyOpenSci Python Package Guide -if you think that better suits your package needs.
- -We recommend that you join the astropy-affiliated-maintainers mailing list to be kept informed of any dicussions related to affiliated packages.
- -Affiliated Package: FAQs¶
- -I want my package to be Astropy Affiliated¶
- -Thank you for your interest! Please see Becoming an Affiliated Package above. When in doubt, feel free to contact Astropy Affiliated Editors for advice.
- -I no longer have time to maintain my Astropy Affiliated package¶
- -Please contact pyOpenSci, as per Peer Review Guidelines & Policies.
- -I want to delist my package as Astropy Affiliated¶
- -Please see Requesting package removal from the pyOpenSci ecosystem.
- -I am a new Editor¶
- -Welcome and thank you! We usually do not switch out all our Editors at the same time, - so the incumbent co-Editor could help you contact pyOpenSci to add you to - pyOpenSci editorial board - with the understanding that we are taking the person you are replacing off that board - and that your role is Astropy- and astronomy-focused.
- -Your name would also be added to Astropy Team under the same role.
- -I am a new reviewer¶
- -Welcome and thank you! Please submit the sign-up form that can be found under -Become a pyOpenSci reviewer. Do not forget to check "Astropy"/"astronomy"/"astrophysics" -when you see them as options.
- -It is important that you understand your reviews will be done in public. There is no option to remain anonymous.
- -
\ + Sort by:\ + best rated\ + newest\ + oldest\ +
\ +\ +
Add a comment\ + (markup):
\ +