Debian Codegraph @

mpl_animators.egg-info/PKG-INFO

raw
1 Metadata-Version: 2.4
2 Name: mpl_animators
3 Version: 1.2.4
4 Summary: An interactive animation framework for matplotlib.
5 Author-email: The SunPy Developers <[email protected]>
6 License: Copyright (c) 2024, The SunPy Developers
7 All rights reserved.
8
9 Redistribution and use in source and binary forms, with or without modification,
10 are permitted provided that the following conditions are met:
11
12 * Redistributions of source code must retain the above copyright notice, this
13 list of conditions and the following disclaimer.
14 * Redistributions in binary form must reproduce the above copyright notice, this
15 list of conditions and the following disclaimer in the documentation and/or
16 other materials provided with the distribution.
17 * Neither the name of the mpl_animators team nor the names of its contributors may be
18 used to endorse or promote products derived from this software without
19 specific prior written permission.
20
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
22 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
25 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
28 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
32 Project-URL: Homepage, https://sunpy.org
33 Project-URL: Source Code, https://github.com/sunpy/mpl-animators
34 Project-URL: Download, https://pypi.org/project/mpl_animators
35 Project-URL: Documentation, https://docs.sunpy.org/projects/mpl-animators
36 Project-URL: Changelog, https://github.com/sunpy/mpl-animators/releases
37 Project-URL: Issue Tracker, https://github.com/sunpy/mpl-animators/issues
38 Requires-Python: >=3.10
39 Description-Content-Type: text/x-rst
40 License-File: LICENSE.rst
41 Requires-Dist: matplotlib>=3.5.0
42 Requires-Dist: numpy>=1.23.0
43 Provides-Extra: wcs
44 Requires-Dist: astropy>=5.3.0; extra == "wcs"
45 Provides-Extra: tests
46 Requires-Dist: pytest; extra == "tests"
47 Requires-Dist: pytest-doctestplus; extra == "tests"
48 Requires-Dist: pytest-cov; extra == "tests"
49 Requires-Dist: pytest-xdist; extra == "tests"
50 Requires-Dist: pytest-mpl; extra == "tests"
51 Provides-Extra: docs
52 Requires-Dist: sphinx; extra == "docs"
53 Requires-Dist: sphinx-automodapi; extra == "docs"
54 Requires-Dist: sphinx-changelog; extra == "docs"
55 Requires-Dist: sunpy-sphinx-theme; extra == "docs"
56 Requires-Dist: packaging; extra == "docs"
57 Requires-Dist: sphinx_gallery; extra == "docs"
58 Requires-Dist: sunpy[map]; extra == "docs"
59 Requires-Dist: scipy; extra == "docs"
60 Provides-Extra: all
61 Requires-Dist: mpl_animators[wcs]; extra == "all"
62 Provides-Extra: dev
63 Requires-Dist: mpl_animators[all,docs,tests]; extra == "dev"
64 Dynamic: license-file
65
66 An interactive animation framework for matplotlib
67 =================================================
68
69 This is for creating interactive animations with matplotlib.
70 It is designed to handle N-dimensional data, and can be used to create animations.
71
72 This package has been spun out of ``sunpy`` to be more generally useful.
73
74 Testing and CI Notes
75 --------------------
76
77 Because this repo is heavily dependent on figure tests, most of the CI jobs
78 (other than publish, and one windows and one macos build) run on Circle CI,
79 there are no test runs on GH Actions. The `-figure` test tox jobs run all tests,
80 figure and non-figure.
81
82 Usage of Generative AI
83 ----------------------
84
85 We expect authentic engagement in our community.
86 Be wary of posting output from Large Language Models or similar generative AI as comments on GitHub or any other platform, as such comments tend to be formulaic and low quality content.
87 If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state.
88
89 License
90 -------
91
92 This project is Copyright (c) The SunPy Developers and licensed under
93 the terms of the BSD 3-Clause license. This package is based upon
94 the `Openastronomy packaging guide <https://github.com/OpenAstronomy/packaging-guide>`_
95 which is licensed under the BSD 3-clause licence. See the licenses folder for
96 more information.
97
98 Contributing
99 ------------
100
101 We love contributions! mpl-animators is open source,
102 built on open source, and we'd love to have you hang out in our community.
103
104 **Imposter syndrome disclaimer**: We want your help. No, really.
105
106 There may be a little voice inside your head that is telling you that you're not
107 ready to be an open source contributor; that your skills aren't nearly good
108 enough to contribute. What could you possibly offer a project like this one?
109
110 We assure you - the little voice in your head is wrong. If you can write code at
111 all, you can contribute code to open source. Contributing to open source
112 projects is a fantastic way to advance one's coding skills. Writing perfect code
113 isn't the measure of a good developer (that would disqualify all of us!); it's
114 trying to create something, making mistakes, and learning from those
115 mistakes. That's how we all improve, and we are happy to help others learn.
116
117 Being an open source contributor doesn't just mean writing code, either. You can
118 help out by writing documentation, tests, or even giving feedback about the
119 project (and yes - that includes giving feedback about the contribution
120 process). Some of these contributions may be the most valuable to the project as
121 a whole, because you're coming to the project with fresh eyes, so you can see
122 the errors and assumptions that seasoned contributors have glossed over.
123
124 Note: This disclaimer was originally written by
125 `Adrienne Lowe <https://github.com/adriennefriend>`_ for a
126 `PyCon talk <https://www.youtube.com/watch?v=6Uj746j9Heo>`_, and was adapted by
127 mpl-animators based on its use in the README file for the
128 `MetPy project <https://github.com/Unidata/MetPy>`_.