-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathdep_versions.html
344 lines (332 loc) · 15.4 KB
/
dep_versions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<title>Dependency version support — SpacePy v0.7.0 Manual</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css?v=92e3d466" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<script src="_static/documentation_options.js?v=fe7df9b0"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script type="text/javascript" src="_static/copybutton.js"></script>
<link rel="icon" href="_static/spacepy_favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Documentation Standard" href="doc_standard.html" />
<link rel="prev" title="SpacePy Python Programming Tips" href="tips.html" />
</head><body>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="index.html"><img src="_static/spacepy_logo.jpg" border="0" alt="spacepy_logo"/></a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="doc_standard.html" title="Documentation Standard"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="tips.html" title="SpacePy Python Programming Tips"
accesskey="P">previous</a> |</li>
<li><a href="https://spacepy.github.io/"">homepage</a>| </li>
<li><a href="https://github.com/spacepy/spacepy">development</a>| </li>
<li><a href="search.html">search</a>| </li>
<li><a href="index.html">documentation </a> »</li>
<li class="nav-item nav-item-this"><a href="">Dependency version support</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="dependency-version-support">
<h1>Dependency version support<a class="headerlink" href="#dependency-version-support" title="Link to this heading">¶</a></h1>
<p>SpacePy will occasionally drop support for old versions of
<a class="reference internal" href="dependencies.html"><span class="doc">dependencies</span></a>. Failures with older versions will
not be treated as SpacePy bugs. Dependency support is based on these
principles:</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>SpacePy supports released versions of a dependency that meet a
minimum version requirement; there is no maximum supported
version.</p></li>
<li><p>Support for old versions of dependencies will be dropped only for
reason, e.g. if a new version is required to support a new feature
or fix a bug. Maintenance of convoluted workarounds is included in
this category.</p></li>
<li><p>Support will be maintained for versions included in the
second-most-recent Ubuntu Long Term Support (LTS) release,
e.g. upon release of Ubuntu 20.04 LTS, support will be maintained
for at least the versions in 18.04 LTS</p></li>
<li><p>Support will also be maintained for Python and NumPy versions
in the spirit of <a class="reference external" href="https://numpy.org/neps/nep-0029-deprecation_policy.html">NEP 29</a>.</p>
<ol class="arabic simple">
<li><p>A SpacePy release will support at least all minor versions of Python
released in the prior 42 months, and at least the two latest minor
versions.</p></li>
<li><p>SpacePy will support all minor versions of NumPy and, where
possible, other Python dependencies released in the prior 24 months,
and at least the three latest minor versions.</p></li>
<li><p>Non-Python dependencies that use a similar versioning system will
be supported similarly where possible.</p></li>
<li><p>This support is based on minor releases (x.y.0), not subsequent
subminor releases (x.y.z for the same x.y). Where x.y.0 is supported,
so is x.y.z for all z.</p></li>
<li><p>All versions of all dependencies and all combinations thereof will
<em>not</em> necessarily be tested in continuous integration. In particular,
CI will only be run against versions of dependencies other than numpy
which have binary wheels available. Numpy may be tested with earlier
versions that do not conflict with other dependencies. For this reason,
the CI configuration is not a reasonable guide of the minimum supported
version.</p></li>
</ol>
</li>
<li><p>No support will be provided for conflicting versions of
dependencies. E.g. SciPy 1.9 requires NumPy 1.18. Although SpacePy
supports SciPy 1.9 and Numpy 1.17, it contains no workarounds for
using them in that combination.</p></li>
<li><p>Support for a particular version of a dependency does not imply
a commitment to work around bugs in that version.</p></li>
<li><p>A release of SpacePy that requires new dependency versions will
always have a subminor version of 0, e.g. if the release that
follows 0.5.2 requires updated dependencies, it will be numbered
0.6.0.</p></li>
<li><p>The commit that requires a newer version of a dependency must also
update the <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code>, <a class="reference internal" href="dependencies.html"><span class="doc">SpacePy Dependencies</span></a>, and the
table below. The commit message must include the reason for the
dependency requirement.</p></li>
</ol>
</div></blockquote>
<p>Regardless of minimum requirements, using the latest stable version of
a package is generally preferred. The minimum supported version for
SpacePy may not be recommended for other reasons (e.g. bug fixes or
improved features elsewhere in the package.)</p>
<p>This table summarizes the versions to be supported according to the
above policy, as well as the minimum version currently supported by
SpacePy. Where available, the dependency name links to its version
history. The oldest version supported according to this policy is in
<strong>bold</strong>.</p>
<table class="docutils align-default" id="id1">
<caption><span class="caption-text">SpacePy dependency versions (2024/6/24)</span><a class="headerlink" href="#id1" title="Link to this table">¶</a></caption>
<colgroup>
<col style="width: 14%" />
<col style="width: 14%" />
<col style="width: 14%" />
<col style="width: 14%" />
<col style="width: 14%" />
<col style="width: 14%" />
<col style="width: 14%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Dependency</p></th>
<th class="head"><p>Current Release</p></th>
<th class="head"><p>Ubuntu 24.04LTS</p></th>
<th class="head"><p>Ubuntu 22.04LTS</p></th>
<th class="head"><p>NEP 29 (42/24 mo.)</p></th>
<th class="head"><p>NEP 29 (2/3 minor versions)</p></th>
<th class="head"><p>SpacePy current minimum</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference external" href="https://www.python.org/downloads/">CPython</a></p></td>
<td><p>3.12.4 (2024/6/6)</p></td>
<td><p>3.12.3 (2024/4/9)</p></td>
<td><p>3.10.4 (2022/3/24)</p></td>
<td><p><strong>3.10.0</strong> (2021/10/4)</p></td>
<td><p>3.11.0 (2022/10/24)</p></td>
<td><p>3.7.0 (2018/6/27)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://docs.astropy.org/en/stable/changelog.html#changelog">AstroPy</a></p></td>
<td><p>6.1.1 (2024/6/14)</p></td>
<td><p>6.0.0 (2023/11/25)</p></td>
<td><p><strong>5.0.2</strong> (2022/3/10)</p></td>
<td><p>5.2 (2022/12/12)</p></td>
<td><p>5.3 (2023/5/22)</p></td>
<td><p>2.0 (2017/7/7)</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://spdf.gsfc.nasa.gov/pub/software/cdf/dist/latest-release/unix/CHANGES.txt">CDF</a></p></td>
<td><p>3.9.0 (2023/1/22)</p></td>
<td><p>N/A</p></td>
<td><p>N/A</p></td>
<td><p>3.9.0 (2023/1/22)</p></td>
<td><p><strong>3.7.0</strong> (2018/5/11)</p></td>
<td><p>3.5.0 (2013/2/25)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://github.com/dateutil/dateutil/releases">dateutil</a></p></td>
<td><p>2.9.0 (2024/2/29)</p></td>
<td><p>2.8.2 (2021/7/8)</p></td>
<td><p>2.8.1 (2019/11/3)</p></td>
<td><p>2.9.0 (2024/2/29)</p></td>
<td><p><strong>2.7.0</strong> (2018/3/11)</p></td>
<td><p>2.5.0 (2016/2/28)</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://github.com/h5py/h5py/releases">h5py</a></p></td>
<td><p>3.11.0 (2024/4/10)</p></td>
<td><p>3.10.0 (2023/10/9)</p></td>
<td><p><strong>3.6.0</strong> (2021/11/16)</p></td>
<td><p>3.8.0 (2023/1/23)</p></td>
<td><p>3.9.0 (2023/6/20)</p></td>
<td><p>2.10.0 (2019/9/6)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://github.com/matplotlib/matplotlib/releases">matplotlib</a></p></td>
<td><p>3.9.0 (2024/5/15)</p></td>
<td><p>3.6.3 (2023/1/11)</p></td>
<td><p><strong>3.5.1</strong> (2021/12/11)</p></td>
<td><p>3.6.0 (2022/9/16)</p></td>
<td><p>3.7.0 (2023/2/13)</p></td>
<td><p>3.1.0 (2019/5/18)</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://github.com/numpy/numpy/releases">numpy</a></p></td>
<td><p>2.0.0 (2024/6/16)</p></td>
<td><p>1.26.4 (2024/2/5)</p></td>
<td><p><strong>1.21.5</strong> (2021/12/19)</p></td>
<td><p>1.24.0 (2022/12/18)</p></td>
<td><p>1.25.0 (2023/6/17)</p></td>
<td><p>1.15.1 (2018/8/21)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://pandas.pydata.org/docs/whatsnew/">pandas</a></p></td>
<td><p>2.2.2 (2024/4/10)</p></td>
<td><p>2.1.4 (2023/12/8)</p></td>
<td><p><strong>1.3.5</strong> (2022/3/10)</p></td>
<td><p>1.5.0 (2022/9/19)</p></td>
<td><p>2.0.0 (2023/4/3)</p></td>
<td><p>0.18.0 (2016/3/13)</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://github.com/scipy/scipy/releases">scipy</a></p></td>
<td><p>1.13.1 (2024/5/23)</p></td>
<td><p>1.11.4 (2023/11/18)</p></td>
<td><p><strong>1.8.0</strong> (2022/2/5)</p></td>
<td><p>1.9.0 (2022/7/29)</p></td>
<td><p>1.11.0 (2023/6/25)</p></td>
<td><p>1.0.0 (2017/10/25)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://pip.pypa.io/en/stable/news/">pip</a></p></td>
<td><p>24.1 (2024/6/20)</p></td>
<td><p>24.0 (2024/2/3)</p></td>
<td><p><strong>22.0.2</strong> (2022/1/30)</p></td>
<td><p>22.2 (2022/7/21)</p></td>
<td><p>23.3 (2023/10/15)</p></td>
<td><p>tested with 20.0.2</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://setuptools.pypa.io/en/latest/history.html">setuptools</a></p></td>
<td><p>70.1.0 (2024/6/19)</p></td>
<td><p>68.1.2 (2023/8/18)</p></td>
<td><p><strong>59.6.0</strong> (2021/12/12)</p></td>
<td><p>63.0.0 (2022/7/4)</p></td>
<td><p>69.4.0 (2024/4/12)</p></td>
<td><p>tested with 44.1.1</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://wheel.readthedocs.io/en/stable/news.html">wheel</a></p></td>
<td><p>0.43.0 (2024/3/11)</p></td>
<td><p>0.42.0 (2023/11/26)</p></td>
<td><p><strong>0.37.1</strong> (2021/12/22)</p></td>
<td><p>0.38.0 (2022/10/21)</p></td>
<td><p>0.41.0 (2023/8/5)</p></td>
<td><p>tested with 0.34.2</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://www.sphinx-doc.org/en/master/changes.html">sphinx</a>
(only needed for developers to build documentation)</p></td>
<td><p>7.3.7 (2024/4/19)</p></td>
<td><p>7.2.6 (2023/9/13)</p></td>
<td><p><strong>4.3.2</strong> (2021/12/19)</p></td>
<td><p>5.1.0 (2022/7/24)</p></td>
<td><p>7.1.0 (2023/7/24)</p></td>
<td><p>4.0.0 (2021/5/9)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://pypa-build.readthedocs.io/en/latest/changelog.html">build</a>
(only needed for developers to build releases)</p></td>
<td><p>1.2.1 (2024/3/28)</p></td>
<td><p>1.0.3 (2023/9/6)</p></td>
<td><p><strong>0.7.0</strong> (2021/9/16)</p></td>
<td><p>0.9.0 (2022/10/27)</p></td>
<td><p>1.0.0 (2023/9/1)</p></td>
<td><p>tested with 0.4.0</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://pypi.org/project/numpydoc/#history">numpydoc</a>
(only needed for developers to build documentation)</p></td>
<td><p>1.8.0 (2024/8/9)</p></td>
<td><p>1.6.0 (2023/9/25)</p></td>
<td><p><strong>1.2.0</strong> (2022/1/24)</p></td>
<td><p>1.5.0 (2022/10/8)</p></td>
<td><p>1.6.0 (2023/9/25)</p></td>
<td><p>0.8.0 (2018/3/30)</p></td>
</tr>
</tbody>
</table>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a></p>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="tips.html"
title="previous chapter">SpacePy Python Programming Tips</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="doc_standard.html"
title="next chapter">Documentation Standard</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/dep_versions.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="doc_standard.html" title="Documentation Standard"
>next</a> |</li>
<li class="right" >
<a href="tips.html" title="SpacePy Python Programming Tips"
>previous</a> |</li>
<li><a href="https://spacepy.github.io/"">homepage</a>| </li>
<li><a href="https://github.com/spacepy/spacepy">development</a>| </li>
<li><a href="search.html">search</a>| </li>
<li><a href="index.html">documentation </a> »</li>
<li class="nav-item nav-item-this"><a href="">Dependency version support</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2011-2024, The SpacePy Team.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
</div>
</body>
</html>