Skip to content

Commit a26e0ab

Browse files
CadairCadair
committed
TMP: Acknoledge
1 parent f99df2c commit a26e0ab

5 files changed

Lines changed: 233 additions & 22 deletions

File tree

‎_static/css/astropy-org.css‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.bd-sidebar-secondary {
2+
background-color: transparent;
3+
}
4+
5+
a.sd-btn {
6+
border: none;
7+
}
8+
9+
a.sd-btn {
10+
color: var(--sst-lightest-color);
11+
background-image: linear-gradient(var(--sst-accent-color-muted), var(--sst-accent-color-bright));
12+
}
13+
14+
a.sd-btn:hover,
15+
a.sd-btn:visited:hover {
16+
color: var(--sst-dark-color);
17+
background: rgba(255, 255, 255, 0.3);
18+
background-blend-mode: lighten;
19+
background-image: linear-gradient(var(--sst-accent-color-muted), var(--sst-accent-color-bright));
20+
text-decoration: none;
21+
}

‎acknowledging.rst‎

Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
.. raw:: html
2+
3+
<style>
4+
div.highlight-latex>div>pre {
5+
white-space: pre-wrap;
6+
}
7+
</style>
8+
9+
.. _astropy-org-acknowledge:
10+
11+
Acknowledging or Citing
12+
=======================
13+
14+
In Publications
15+
---------------
16+
17+
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.
18+
We encourage you to cite all three papers, but if space is limited, please cite the most recent paper:
19+
20+
- `Astropy Paper III (v5.0) <https://arxiv.org/abs/2206.14220>`__ (`ADS <https://ui.adsabs.harvard.edu/abs/2022ApJ...935..167A>`__ - `BibTeX <https://ui.adsabs.harvard.edu/abs/2022ApJ...935..167A/exportcitation>`__)
21+
- `Astropy Paper II (v2.0) <https://arxiv.org/abs/1801.02634>`__ (`ADS <http://adsabs.harvard.edu/abs/2018arXiv180102634T>`__ - `BibTeX <https://ui.adsabs.harvard.edu/abs/2018AJ....156..123A/exportcitation>`__)
22+
- `Astropy Paper I (v0.2) <https://doi.org/10.1051/0004-6361/201322068>`__ (`ADS <http://adsabs.harvard.edu/abs/2013A%26A...558A..33A>`__ - `BibTeX <https://ui.adsabs.harvard.edu/abs/2013A%26A...558A..33A/exportcitation>`__ - `10k citations <paper1_10k_citation.html#astropy-paper-reaches-10-000-citations-article>`__)
23+
24+
.. raw:: html
25+
26+
<p><a class="sd-sphinx-override sd-btn sd-text-wrap reference external" onClick="copyBibtex()"><span id="bibtexcopy">Copy all BibTeX to clipboard</span></a></p>
27+
28+
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 <https://journals.aas.org/aastexguide/#software>`__),
29+
e.g.:
30+
31+
.. code-block:: latex
32+
33+
\software{Astropy \citep{astropy:2013, astropy:2018, astropy:2022}}
34+
35+
(but please also consider adding and citing other software packages that you use to this list as well).
36+
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:
37+
38+
.. code-block:: latex
39+
40+
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}.
41+
42+
As an alternative, the BibTeX record recommended for a given version of Astropy is available from the Python package itself:
43+
44+
.. code-block:: python
45+
46+
import astropy
47+
astropy.__citation__
48+
49+
50+
In Presentations
51+
----------------
52+
53+
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:
54+
55+
|Powered by Astropy|
56+
57+
The logo is also available `with white text <http://www.astropy.org/images/astropy_powered_white.png>`__, or the SVG originals can be obtained at the `astropy-logo github repository. <http://github.com/astropy/astropy-logo>`__
58+
59+
In Projects
60+
-----------
61+
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.
62+
We suggest this badge:
63+
64+
|Powered by Astropy Badge|
65+
66+
Which is available at the URL http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
67+
You can place the following in your ``README.md`` file to get the badge:
68+
69+
.. code-block:: markdown
70+
71+
[![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat)](http://www.astropy.org/)
72+
73+
.. |Powered by Astropy| image:: http://www.astropy.org/images/astropy_powered.png
74+
:width: 256px
75+
.. |Powered by Astropy Badge| image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
76+
77+
78+
.. raw:: html
79+
80+
<script type="text/javascript">
81+
function copyBibtex() {
82+
var bibtex2013 = `@article{astropy:2013,
83+
Adsnote = {Provided by the SAO/NASA Astrophysics Data System},
84+
Adsurl = {http://adsabs.harvard.edu/abs/2013A%26A...558A..33A},
85+
Archiveprefix = {arXiv},
86+
Author = {{Astropy Collaboration} and {Robitaille}, T.~P. and {Tollerud}, E.~J. and {Greenfield}, P. and {Droettboom}, M. and {Bray}, E. and {Aldcroft}, T. and {Davis}, M. and {Ginsburg}, A. and {Price-Whelan}, A.~M. and {Kerzendorf}, W.~E. and {Conley}, A. and {Crighton}, N. and {Barbary}, K. and {Muna}, D. and {Ferguson}, H. and {Grollier}, F. and {Parikh}, M.~M. and {Nair}, P.~H. and {Unther}, H.~M. and {Deil}, C. and {Woillez}, J. and {Conseil}, S. and {Kramer}, R. and {Turner}, J.~E.~H. and {Singer}, L. and {Fox}, R. and {Weaver}, B.~A. and {Zabalza}, V. and {Edwards}, Z.~I. and {Azalee Bostroem}, K. and {Burke}, D.~J. and {Casey}, A.~R. and {Crawford}, S.~M. and {Dencheva}, N. and {Ely}, J. and {Jenness}, T. and {Labrie}, K. and {Lim}, P.~L. and {Pierfederici}, F. and {Pontzen}, A. and {Ptak}, A. and {Refsdal}, B. and {Servillat}, M. and {Streicher}, O.},
87+
Doi = {10.1051/0004-6361/201322068},
88+
Eid = {A33},
89+
Eprint = {1307.6212},
90+
Journal = {\\aap},
91+
Keywords = {methods: data analysis, methods: miscellaneous, virtual observatory tools},
92+
Month = oct,
93+
Pages = {A33},
94+
Primaryclass = {astro-ph.IM},
95+
Title = {{Astropy: A community Python package for astronomy}},
96+
Volume = 558,
97+
Year = 2013,
98+
Bdsk-Url-1 = {https://dx.doi.org/10.1051/0004-6361/201322068}}`;
99+
var bibtex2018 = `@ARTICLE{astropy:2018,
100+
author = {{Astropy Collaboration} and {Price-Whelan}, A.~M. and
101+
{Sip{\\H{o}}cz}, B.~M. and {G{\\"u}nther}, H.~M. and {Lim}, P.~L. and
102+
{Crawford}, S.~M. and {Conseil}, S. and {Shupe}, D.~L. and
103+
{Craig}, M.~W. and {Dencheva}, N. and {Ginsburg}, A. and {Vand
104+
erPlas}, J.~T. and {Bradley}, L.~D. and {P{\\'e}rez-Su{\\'a}rez}, D. and
105+
{de Val-Borro}, M. and {Aldcroft}, T.~L. and {Cruz}, K.~L. and
106+
{Robitaille}, T.~P. and {Tollerud}, E.~J. and {Ardelean}, C. and
107+
{Babej}, T. and {Bach}, Y.~P. and {Bachetti}, M. and {Bakanov}, A.~V. and
108+
{Bamford}, S.~P. and {Barentsen}, G. and {Barmby}, P. and
109+
{Baumbach}, A. and {Berry}, K.~L. and {Biscani}, F. and {Boquien}, M. and
110+
{Bostroem}, K.~A. and {Bouma}, L.~G. and {Brammer}, G.~B. and
111+
{Bray}, E.~M. and {Breytenbach}, H. and {Buddelmeijer}, H. and
112+
{Burke}, D.~J. and {Calderone}, G. and {Cano Rodr{\\'\\i}guez}, J.~L. and
113+
{Cara}, M. and {Cardoso}, J.~V.~M. and {Cheedella}, S. and {Copin}, Y. and
114+
{Corrales}, L. and {Crichton}, D. and {D'Avella}, D. and {Deil}, C. and
115+
{Depagne}, {\\'E}. and {Dietrich}, J.~P. and {Donath}, A. and
116+
{Droettboom}, M. and {Earl}, N. and {Erben}, T. and {Fabbro}, S. and
117+
{Ferreira}, L.~A. and {Finethy}, T. and {Fox}, R.~T. and
118+
{Garrison}, L.~H. and {Gibbons}, S.~L.~J. and {Goldstein}, D.~A. and
119+
{Gommers}, R. and {Greco}, J.~P. and {Greenfield}, P. and
120+
{Groener}, A.~M. and {Grollier}, F. and {Hagen}, A. and {Hirst}, P. and
121+
{Homeier}, D. and {Horton}, A.~J. and {Hosseinzadeh}, G. and {Hu}, L. and
122+
{Hunkeler}, J.~S. and {Ivezi{\\'c}}, {\\v{Z}}. and {Jain}, A. and
123+
{Jenness}, T. and {Kanarek}, G. and {Kendrew}, S. and {Kern}, N.~S. and
124+
{Kerzendorf}, W.~E. and {Khvalko}, A. and {King}, J. and {Kirkby}, D. and
125+
{Kulkarni}, A.~M. and {Kumar}, A. and {Lee}, A. and {Lenz}, D. and
126+
{Littlefair}, S.~P. and {Ma}, Z. and {Macleod}, D.~M. and
127+
{Mastropietro}, M. and {McCully}, C. and {Montagnac}, S. and
128+
{Morris}, B.~M. and {Mueller}, M. and {Mumford}, S.~J. and {Muna}, D. and
129+
{Murphy}, N.~A. and {Nelson}, S. and {Nguyen}, G.~H. and
130+
{Ninan}, J.~P. and {N{\\"o}the}, M. and {Ogaz}, S. and {Oh}, S. and
131+
{Parejko}, J.~K. and {Parley}, N. and {Pascual}, S. and {Patil}, R. and
132+
{Patil}, A.~A. and {Plunkett}, A.~L. and {Prochaska}, J.~X. and
133+
{Rastogi}, T. and {Reddy Janga}, V. and {Sabater}, J. and
134+
{Sakurikar}, P. and {Seifert}, M. and {Sherbert}, L.~E. and
135+
{Sherwood-Taylor}, H. and {Shih}, A.~Y. and {Sick}, J. and
136+
{Silbiger}, M.~T. and {Singanamalla}, S. and {Singer}, L.~P. and
137+
{Sladen}, P.~H. and {Sooley}, K.~A. and {Sornarajah}, S. and
138+
{Streicher}, O. and {Teuben}, P. and {Thomas}, S.~W. and
139+
{Tremblay}, G.~R. and {Turner}, J.~E.~H. and {Terr{\\'o}n}, V. and
140+
{van Kerkwijk}, M.~H. and {de la Vega}, A. and {Watkins}, L.~L. and
141+
{Weaver}, B.~A. and {Whitmore}, J.~B. and {Woillez}, J. and
142+
{Zabalza}, V. and {Astropy Contributors}},
143+
title = "{The Astropy Project: Building an Open-science Project and Status of the v2.0 Core Package}",
144+
journal = {\\aj},
145+
keywords = {methods: data analysis, methods: miscellaneous, methods: statistical, reference systems, Astrophysics - Instrumentation and Methods for Astrophysics},
146+
year = 2018,
147+
month = sep,
148+
volume = {156},
149+
number = {3},
150+
eid = {123},
151+
pages = {123},
152+
doi = {10.3847/1538-3881/aabc4f},
153+
archivePrefix = {arXiv},
154+
eprint = {1801.02634},
155+
primaryClass = {astro-ph.IM},
156+
adsurl = {https://ui.adsabs.harvard.edu/abs/2018AJ....156..123A},
157+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
158+
}`;
159+
var bibtex2022 = `@ARTICLE{astropy:2022,
160+
author = {{Astropy Collaboration} and {Price-Whelan}, Adrian M. and {Lim}, Pey Lian and {Earl}, Nicholas and {Starkman}, Nathaniel and {Bradley}, Larry and {Shupe}, David L. and {Patil}, Aarya A. and {Corrales}, Lia and {Brasseur}, C.~E. and {N{\"o}the}, Maximilian and {Donath}, Axel and {Tollerud}, Erik and {Morris}, Brett M. and {Ginsburg}, Adam and {Vaher}, Eero and {Weaver}, Benjamin A. and {Tocknell}, James and {Jamieson}, William and {van Kerkwijk}, Marten H. and {Robitaille}, Thomas P. and {Merry}, Bruce and {Bachetti}, Matteo and {G{\"u}nther}, H. Moritz and {Aldcroft}, Thomas L. and {Alvarado-Montes}, Jaime A. and {Archibald}, Anne M. and {B{\'o}di}, Attila and {Bapat}, Shreyas and {Barentsen}, Geert and {Baz{\'a}n}, Juanjo and {Biswas}, Manish and {Boquien}, M{\'e}d{\'e}ric and {Burke}, D.~J. and {Cara}, Daria and {Cara}, Mihai and {Conroy}, Kyle E. and {Conseil}, Simon and {Craig}, Matthew W. and {Cross}, Robert M. and {Cruz}, Kelle L. and {D'Eugenio}, Francesco and {Dencheva}, Nadia and {Devillepoix}, Hadrien A.~R. and {Dietrich}, J{\"o}rg P. and {Eigenbrot}, Arthur Davis and {Erben}, Thomas and {Ferreira}, Leonardo and {Foreman-Mackey}, Daniel and {Fox}, Ryan and {Freij}, Nabil and {Garg}, Suyog and {Geda}, Robel and {Glattly}, Lauren and {Gondhalekar}, Yash and {Gordon}, Karl D. and {Grant}, David and {Greenfield}, Perry and {Groener}, Austen M. and {Guest}, Steve and {Gurovich}, Sebastian and {Handberg}, Rasmus and {Hart}, Akeem and {Hatfield-Dodds}, Zac and {Homeier}, Derek and {Hosseinzadeh}, Griffin and {Jenness}, Tim and {Jones}, Craig K. and {Joseph}, Prajwel and {Kalmbach}, J. Bryce and {Karamehmetoglu}, Emir and {Ka{\l}uszy{\'n}ski}, Miko{\l}aj and {Kelley}, Michael S.~P. and {Kern}, Nicholas and {Kerzendorf}, Wolfgang E. and {Koch}, Eric W. and {Kulumani}, Shankar and {Lee}, Antony and {Ly}, Chun and {Ma}, Zhiyuan and {MacBride}, Conor and {Maljaars}, Jakob M. and {Muna}, Demitri and {Murphy}, N.~A. and {Norman}, Henrik and {O'Steen}, Richard and {Oman}, Kyle A. and {Pacifici}, Camilla and {Pascual}, Sergio and {Pascual-Granado}, J. and {Patil}, Rohit R. and {Perren}, Gabriel I. and {Pickering}, Timothy E. and {Rastogi}, Tanuj and {Roulston}, Benjamin R. and {Ryan}, Daniel F. and {Rykoff}, Eli S. and {Sabater}, Jose and {Sakurikar}, Parikshit and {Salgado}, Jes{\'u}s and {Sanghi}, Aniket and {Saunders}, Nicholas and {Savchenko}, Volodymyr and {Schwardt}, Ludwig and {Seifert-Eckert}, Michael and {Shih}, Albert Y. and {Jain}, Anany Shrey and {Shukla}, Gyanendra and {Sick}, Jonathan and {Simpson}, Chris and {Singanamalla}, Sudheesh and {Singer}, Leo P. and {Singhal}, Jaladh and {Sinha}, Manodeep and {Sip{\H{o}}cz}, Brigitta M. and {Spitler}, Lee R. and {Stansby}, David and {Streicher}, Ole and {{\v{S}}umak}, Jani and {Swinbank}, John D. and {Taranu}, Dan S. and {Tewary}, Nikita and {Tremblay}, Grant R. and {Val-Borro}, Miguel de and {Van Kooten}, Samuel J. and {Vasovi{\'c}}, Zlatan and {Verma}, Shresth and {de Miranda Cardoso}, Jos{\'e} Vin{\'\i}cius and {Williams}, Peter K.~G. and {Wilson}, Tom J. and {Winkel}, Benjamin and {Wood-Vasey}, W.~M. and {Xue}, Rui and {Yoachim}, Peter and {Zhang}, Chen and {Zonca}, Andrea and {Astropy Project Contributors}},
161+
title = "{The Astropy Project: Sustaining and Growing a Community-oriented Open-source Project and the Latest Major Release (v5.0) of the Core Package}",
162+
journal = {\\apj},
163+
keywords = {Astronomy software, Open source software, Astronomy data analysis, 1855, 1866, 1858, Astrophysics - Instrumentation and Methods for Astrophysics},
164+
year = 2022,
165+
month = aug,
166+
volume = {935},
167+
number = {2},
168+
eid = {167},
169+
pages = {167},
170+
doi = {10.3847/1538-4357/ac7c74},
171+
archivePrefix = {arXiv},
172+
eprint = {2206.14220},
173+
primaryClass = {astro-ph.IM},
174+
adsurl = {https://ui.adsabs.harvard.edu/abs/2022ApJ...935..167A},
175+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
176+
}
177+
`;
178+
179+
const temp = document.createElement("textarea");
180+
document.body.appendChild(temp);
181+
temp.value = bibtex2013 + '\r\n\r\n' + bibtex2018 + '\r\n\r\n' + bibtex2022;
182+
temp.select();
183+
document.execCommand("copy");
184+
document.body.removeChild(temp);
185+
// Get the element
186+
const bibtexCopyElement = document.getElementById("bibtexcopy");
187+
188+
// Store the original text
189+
const originalText = bibtexCopyElement.textContent;
190+
191+
// Change the text
192+
bibtexCopyElement.textContent = "Copied!";
193+
194+
// Revert to the original text after 5 seconds
195+
setTimeout(() => {
196+
bibtexCopyElement.textContent = originalText;
197+
}, 1000);
198+
199+
}
200+
</script>

‎conf.py‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
extensions = [
1717
"myst_parser",
1818
"sphinx_design",
19+
"sphinx_copybutton",
1920
]
2021

2122
templates_path = ['_templates']
@@ -34,6 +35,7 @@
3435
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
3536

3637
html_theme = 'astropy'
38+
3739
html_static_path = ['_static']
3840

3941
html_theme_options = {
@@ -42,5 +44,9 @@
4244
}
4345

4446
html_sidebars = {
45-
"index": [],
47+
"*": [],
4648
}
49+
50+
html_css_files = [
51+
"css/astropy-org.css"
52+
]

‎index.rst‎

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
.. astropy-org:index
1+
.. _astropy-org-index:
2+
23
Astropy
34
=======
45

56
.. toctree::
67
:maxdepth: 0
78
:hidden:
89

9-
about/index
10+
acknowledging
1011

1112
.. raw:: html
1213

@@ -29,7 +30,7 @@ The Astropy community is committed to supporting the :ref:`astropy-org:coc`.
2930

3031
.. rst-class:: acknowledge
3132

32-
Please remember to :ref:`astropy-org:acknowledge` the use of Astropy!
33+
Please remember to :ref:`acknowledge and cite <astropy-org-acknowledge>` the use of Astropy!
3334

3435
.. raw:: html
3536

@@ -241,24 +242,6 @@ encouraged to submit talks, etc. and other relevant materials.
241242
margin-bottom: 0;
242243
}
243244
244-
a.sd-btn {
245-
border: none;
246-
}
247-
248-
a.sd-btn {
249-
color: var(--sst-lightest-color);
250-
background-image: linear-gradient(var(--sst-accent-color-muted), var(--sst-accent-color-bright));
251-
}
252-
253-
a.sd-btn:hover,
254-
a.sd-btn:visited:hover {
255-
color: var(--sst-dark-color);
256-
background: rgba(255, 255, 255, 0.3);
257-
background-blend-mode: lighten;
258-
background-image: linear-gradient(var(--sst-accent-color-muted), var(--sst-accent-color-bright));
259-
text-decoration: none;
260-
}
261-
262245
.sd-container, .sd-container-fluid, .sd-container-lg, .sd-container-md, .sd-container-sm, .sd-container-xl {
263246
padding-left: 0;
264247
padding-right: 0;

‎requirements.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ sphinx
22
myst-parser
33
sphinx-design
44
sphinx-astropy[confv3]@git+https://github.com/Cadair/sphinx-astropy@conf-v3-sunpy
5+
sphinx-copybutton

0 commit comments

Comments
 (0)