From b3ca133fb999e184e58ce25a187f2d73f2ceee35 Mon Sep 17 00:00:00 2001 From: Lukas Winkler Date: Thu, 14 Jan 2021 19:09:42 +0100 Subject: [PATCH] initial version --- LICENSE | 674 +++++++++++++++++++++++++++++++++ README.md | 5 + rebound-stubs | 1 + rebound/__init__.pyi | 22 ++ rebound/citations.pyi | 6 + rebound/data.pyi | 7 + rebound/horizons.pyi | 10 + rebound/interruptible_pool.pyi | 7 + rebound/particle.pyi | 144 +++++++ rebound/plotting.pyi | 32 ++ rebound/simulation.pyi | 585 ++++++++++++++++++++++++++++ rebound/simulationarchive.pyi | 38 ++ rebound/tools.pyi | 6 + rebound/types.pyi | 4 + rebound/units.pyi | 35 ++ rebound/widget.pyi | 38 ++ setup.py | 29 ++ 17 files changed, 1643 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 120000 rebound-stubs create mode 100644 rebound/__init__.pyi create mode 100644 rebound/citations.pyi create mode 100644 rebound/data.pyi create mode 100644 rebound/horizons.pyi create mode 100644 rebound/interruptible_pool.pyi create mode 100644 rebound/particle.pyi create mode 100644 rebound/plotting.pyi create mode 100644 rebound/simulation.pyi create mode 100644 rebound/simulationarchive.pyi create mode 100644 rebound/tools.pyi create mode 100644 rebound/types.pyi create mode 100644 rebound/units.pyi create mode 100644 rebound/widget.pyi create mode 100644 setup.py diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..39e4675 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# PEP 561 compatible type-hint package for [rebound](https://github.com/hannorein/rebound) + +### License + +Licensed under GPL-3.0, based on [rebound](https://github.com/hannorein/rebound) by Hanno Rein diff --git a/rebound-stubs b/rebound-stubs new file mode 120000 index 0000000..c7d66b7 --- /dev/null +++ b/rebound-stubs @@ -0,0 +1 @@ +rebound \ No newline at end of file diff --git a/rebound/__init__.pyi b/rebound/__init__.pyi new file mode 100644 index 0000000..b147823 --- /dev/null +++ b/rebound/__init__.pyi @@ -0,0 +1,22 @@ +from .interruptible_pool import InterruptiblePool as InterruptiblePool +from .particle import Particle as Particle +from .plotting import OrbitPlot as OrbitPlot +from .simulation import Orbit as Orbit, Simulation as Simulation, Variation as Variation, reb_simulation_integrator_mercurius as reb_simulation_integrator_mercurius, reb_simulation_integrator_saba as reb_simulation_integrator_saba, reb_simulation_integrator_sei as reb_simulation_integrator_sei, reb_simulation_integrator_whfast as reb_simulation_integrator_whfast +from .simulationarchive import SimulationArchive as SimulationArchive +from typing import Any + +__libpath__: Any +clibrebound: Any +__build__: Any +__githash__: Any + +class SimulationError(Exception): ... +class Encounter(Exception): ... +class Collision(Exception): ... +class Escape(Exception): ... +class NoParticles(Exception): ... +class ParticleNotFound(Exception): ... + +# Names in __all__ with no definition: +# __version__ +# reb_simulation_integrator_ias15 diff --git a/rebound/citations.pyi b/rebound/citations.pyi new file mode 100644 index 0000000..988dbc4 --- /dev/null +++ b/rebound/citations.pyi @@ -0,0 +1,6 @@ +from typing import Tuple + +from rebound import Simulation + + +def cite(sim: Simulation) -> Tuple[str, str]: ... diff --git a/rebound/data.pyi b/rebound/data.pyi new file mode 100644 index 0000000..cb581f5 --- /dev/null +++ b/rebound/data.pyi @@ -0,0 +1,7 @@ +from typing import Any + +from rebound import Simulation + + +def add_outer_solar_system(sim: Simulation) -> None: ... +def add_solar_system(sim: Simulation) -> None: ... diff --git a/rebound/horizons.pyi b/rebound/horizons.pyi new file mode 100644 index 0000000..43bb0de --- /dev/null +++ b/rebound/horizons.pyi @@ -0,0 +1,10 @@ +from typing import Optional + +from rebound import Particle + + +def getParticle(particle: Optional[str], m: Optional[float], x: Optional[float], y: Optional[float], z: Optional[float], + vx: Optional[float], vy: Optional[float], vz: Optional[float], primary: Optional[float], + a: Optional[float], anom: Optional[float], e: Optional[float], omega: Optional[float], + inc: Optional[float], Omega: Optional[float], MEAN: Optional[float], date: Optional[float], + plane: str, hash: int) -> Particle: ... diff --git a/rebound/interruptible_pool.pyi b/rebound/interruptible_pool.pyi new file mode 100644 index 0000000..c63d602 --- /dev/null +++ b/rebound/interruptible_pool.pyi @@ -0,0 +1,7 @@ +from multiprocessing.pool import Pool +from typing import Any, Optional + +class InterruptiblePool(Pool): + wait_timeout: int = ... + def __init__(self, processes: Optional[Any] = ..., initializer: Optional[Any] = ..., initargs: Any = ..., **kwargs: Any) -> None: ... + def map(self, func: Any, iterable: Any, chunksize: Optional[Any] = ...): ... diff --git a/rebound/particle.pyi b/rebound/particle.pyi new file mode 100644 index 0000000..6cb8902 --- /dev/null +++ b/rebound/particle.pyi @@ -0,0 +1,144 @@ +from ctypes import Structure, c_uint32 +from typing import Any, Optional, List + +from rebound import Simulation, Orbit +from rebound.types import HashType + + +class Particle(Structure): + m: float + x: float + y: float + z: float + vx: float + vy: float + vz: float + ax: float + ay: float + az: float + r: float + lastcollision: float + c: Any # TODO: find out documentation + ap: Any # TODO: find out documentation + + def __init__(self, simulation: Optional[Simulation] = ..., particle: Optional[Particle] = ..., + m: Optional[float] = ..., x: Optional[float] = ..., y: Optional[float] = ..., z: Optional[float] = ..., + vx: Optional[float] = ..., vy: Optional[float] = ..., vz: Optional[float] = ..., + primary: Optional[Particle] = ..., a: Optional[float] = ..., P: Optional[float] = ..., + e: Optional[float] = ..., inc: Optional[float] = ..., Omega: Optional[float] = ..., + omega: Optional[float] = ..., pomega: Optional[float] = ..., f: Optional[float] = ..., + M: Optional[float] = ..., l: Optional[float] = ..., theta: Optional[float] = ..., + T: Optional[float] = ..., r: Optional[float] = ..., date: Optional[str] = ..., + variation: Optional[str] = ..., variation2: Optional[str] = ..., h: Optional[HashType] = ..., + k: Optional[float] = ..., ix: Optional[float] = ..., iy: Optional[float] = ..., hash: HashType = ..., + jacobi_masses: bool = ...): ... + + def copy(self) -> Particle: ... + + def calculate_orbit(self, primary: Optional[Particle], G: Optional[float]): ... + + def sample_orbit(self, Npts: int, primary: Optional[Particle], trailing: bool, + timespan: Optional[float], useTrueAnomaly: Optional[bool], + duplicateEndpoint: Optional[bool]): ... + + def __pow__(self, other: Particle) -> Particle: ... + + def __add__(self, other: Particle) -> Particle: ... + + def __iadd__(self, other: Particle) -> Particle: ... + + def __sub__(self, other: Particle) -> Particle: ... + + def __isub__(self, other: Particle) -> Particle: ... + + def __mul__(self, other: float) -> Particle: ... + + def __imul__(self, other: float) -> Particle: ... + + def __rmul__(self, other: float) -> Particle: ... + + def __div__(self, other: float) -> Particle: ... + + def __idiv__(self, other: float) -> Particle: ... + + def __truediv__(self, other: float) -> Particle: ... + + def __itruediv__(self, other: float) -> Particle: ... + + @property + def index(self) -> int: ... + + @property + def xyz(self) -> List[float]: ... + + @xyz.setter + def xyz(self, value: List[float]) -> None: ... + + @property + def vxyz(self) -> List[float]: ... + + @vxyz.setter + def vxyz(self, value: List[float]) -> None: ... + + @property + def d(self) -> float: ... + + @property + def v(self) -> float: ... + + @property + def h(self) -> float: ... + + @property + def P(self) -> float: ... + + @property + def n(self) -> float: ... + + @property + def a(self) -> float: ... + + @property + def rhill(self) -> float: ... + + @property + def e(self) -> float: ... + + @property + def inc(self) -> float: ... + + @property + def Omega(self) -> float: ... + + @property + def omega(self) -> float: ... + + @property + def pomega(self) -> float: ... + + @property + def f(self) -> float: ... + + @property + def M(self) -> float: ... + + @property + def l(self) -> float: ... + + @property + def theta(self) -> float: ... + + @property + def T(self) -> float: ... + + @property + def orbit(self) -> Orbit: ... + + @property + def jacobi_com(self): ... #TODO: correct tpying + + @property + def hash(self) -> c_uint32: ... + + @hash.setter + def hash(self, value: HashType) -> None: ... diff --git a/rebound/plotting.pyi b/rebound/plotting.pyi new file mode 100644 index 0000000..cbd9081 --- /dev/null +++ b/rebound/plotting.pyi @@ -0,0 +1,32 @@ +from typing import Any, Optional, Tuple, Union, List, Iterable + +from matplotlib.axes import Axes +from matplotlib.collections import LineCollection +from matplotlib.figure import Figure + +from rebound import Simulation, Particle + +Limits = Tuple[float, float] +ColorTuple = Tuple[int, int, int] + + +def OrbitPlot(sim: Simulation, figsize: Optional[Tuple[float, float]] = ..., fancy: bool = ..., + slices: Optional[int] = ..., xlim: Optional[Limits] = ..., ylim: Optional[Limits] = ..., + unitlabel: Optional[str] = ..., color: Union[str, bool, List, None] = ..., periastron: bool = ..., + orbit_type: str = ..., lw: float = ..., plotparticles: List[int] = ..., primary: Optional[Particle] = ..., + Narc: int = ...) -> Union[Tuple[Figure, Axes], Tuple[Figure, Axes, Axes, Axes]]: ... + + +def get_color(color: str) -> ColorTuple: ... + + +def fading_line(x: Iterable[float], y: Iterable[float], color: Union[str, ColorTuple] = ..., alpha_initial: float = ..., + alpha_final: float = ..., glow: bool = ..., **kwargs: Any) -> LineCollection: ... + + +def OrbitPlotOneSlice(sim: Simulation, ax: Axes, Narc: int = ..., color: bool = ..., periastron: bool = ..., + orbit_type: str = ..., lw: float = ..., axes: str = ..., plotparticles: List[int] = ..., + primary: Optional[Particle] = ..., fancy: bool = ...) -> None: ... + + +def OrbitPlotAddFancyStars(ax: Axes, lw: float, slices: float = ...) -> None: ... diff --git a/rebound/simulation.pyi b/rebound/simulation.pyi new file mode 100644 index 0000000..33e1c3c --- /dev/null +++ b/rebound/simulation.pyi @@ -0,0 +1,585 @@ +from collections import MutableMapping +from ctypes import Structure, POINTER, c_void_p, c_uint, c_uint32, c_ulong +from typing import Any, Optional, Dict, List, Tuple, Callable, Union, Literal, Iterator + +from rebound import Particle +from rebound.types import HashType +from rebound.widget import Widget + +EnumDict = Dict[str, int] +IntBoolean = Literal[0, 1] + +INTEGRATORS: EnumDict +BOUNDARIES: EnumDict +GRAVITIES: EnumDict +COLLISIONS: EnumDict +VISUALIZATIONS: EnumDict +WHFAST_KERNELS: EnumDict +WHFAST_COORDINATES: EnumDict +SABA_TYPES: EnumDict +EOS_TYPES: EnumDict +BINARY_WARNINGS: List[Tuple[bool, int, str]] + + +class reb_hash_pointer_pair(Structure): + hash: int + index: int + + +class reb_vec3d(Structure): + x: float + y: float + z: float + + +class reb_dp7(Structure): + p0: POINTER(float) + p1: POINTER(float) + p2: POINTER(float) + p3: POINTER(float) + p4: POINTER(float) + p5: POINTER(float) + p6: POINTER(float) + + +class reb_ghostbox(Structure): + shiftx: float + shifty: float + shiftz: float + shiftvx: float + shiftvy: float + shiftvz: float + + +class reb_collision(Structure): + p1: int + p2: int + gb: reb_ghostbox + time: float + ri: int + + +class reb_simulation_integrator_sei(Structure): + OMEGA: float + OMEGAZ: float + _lastdt: float + _sindt: float + _tandt: float + _sindtz: float + _tandtz: float + + +class reb_simulation_integrator_ias15(Structure): + epsilon: float + min_dt: float + epsilon_global: int + neworder: int + _iterations_max_exceeded: int + _allocatedN: int + _at: POINTER(float) + _x0: POINTER(float) + _v0: POINTER(float) + _a0: POINTER(float) + _csx: POINTER(float) + _csv: POINTER(float) + _csa0: POINTER(float) + _g: reb_dp7 + _b: reb_dp7 + _csb: reb_dp7 + _e: reb_dp7 + _br: reb_dp7 + _er: reb_dp7 + _map: POINTER(int) + _map_allocated_n: POINTER(int) + + +class reb_simulation_integrator_saba(Structure): + _type: int + safe_mode: IntBoolean + is_synchronized: IntBoolean + keep_unsynchronized: IntBoolean + + @property + def type(self) -> str: ... + + @type.setter + def type(self, value: str) -> None: ... + + +class reb_simulation_integrator_whfast(Structure): + corrector: int + corrector2: int + _kernel: int + _coordinates: int + recalculate_coordinates_this_timestep: IntBoolean + safe_mode: IntBoolean + _p_jh: POINTER(Particle) + _p_temp: POINTER(Particle) + keep_unsynchronized: IntBoolean + is_synchronized: IntBoolean + _allocatedN: int + _timestep_warning: int + _recalculate_coordinates_but_not_synchronized_warning: int + + @property + def coordinates(self) -> str: ... + + @coordinates.setter + def coordinates(self, value: str) -> None: ... + + @property + def kernel(self) -> str: ... + + @kernel.setter + def kernel(self, value: str) -> None: ... + + +class Orbit(Structure): + d: float + v: float + h: float + P: float + n: float + a: float + e: float + inc: float + Omega: float + omega: float + pomega: float + f: float + M: float + l: float + theta: float + T: float + rhill: float + + +class Simulation(Structure): + t: float + G: float + softening: float + dt: float + dt_last_done: float + steps_done: int + N: int + N_var: int + var_config_N: int + var_config: POINTER(Variation) + N_active: int + testparticle_type: int + _particle_lookup_table: POINTER(reb_hash_pointer_pair) + hash_ctr: int + N_lookup: int + allocatedN_lookup: int + allocated_N: int + _particles: POINTER(Particle) + gravity_cs: POINTER(reb_vec3d) + gravity_cs_allocatedN: int + _tree_root: c_void_p + _tree_needs_update: int + opening_angle2: float + _status: int + exact_finish_time: int + force_is_velocity_dependent: c_uint + gravity_ignore: c_uint + _output_timing_last: float + _display_clock: int + save_messages: int + messages: c_void_p + exit_max_distance: float + exit_min_distance: float + usleep: float + display_data: POINTER(reb_display_data) + track_energy_offset: int + energy_offset: float + walltime: float + python_unit_t: int + python_unit_l: int + python_unit_m: int + boxsize: reb_vec3d + boxsize_max: float + root_size: float + root_n: int + root_nx: int + root_ny: int + root_nz: int + nghostx: int + nghosty: int + nghostz: int + collision_resolve_keep_sorted: int + collisions: c_void_p + collisions_allocatedN: int + minimum_collision_velocity: float + collisions_plog: float + max_radius: float * 2 + collisions_Nlog: int + _calculate_megno: int + _megno_Ys: float + _megno_Yss: float + _megno_cov_Yt: float + _megno_var_t: float + _megno_mean_t: float + _megno_mean_Y: float + _megno_n: int + simulationarchive_version: int + simulationarchive_size_first: int + simulationarchive_size_snapshot: int + simulationarchive_auto_interval: float + simulationarchive_auto_walltime: float + simulationarchive_auto_step: int + simulationarchive_next: float + simulationarchive_next_step: int + _simulationarchive_filename: bytes + _visualization: int + _collision: int + _integrator: int + _boundary: int + _gravity: int + ri_sei: reb_simulation_integrator_sei + ri_whfast: reb_simulation_integrator_whfast + ri_saba: reb_simulation_integrator_saba + ri_ias15: reb_simulation_integrator_ias15 + ri_mercurius: reb_simulation_integrator_mercurius + ri_janus: reb_simulation_integrator_janus + ri_eos: reb_simulation_integrator_eos + # _additional_forces: CFUNCTYPE(None, POINTER(Simulation)) + # _pre_timestep_modifications: CFUNCTYPE(None, POINTER(Simulation)) + # _post_timestep_modifications: CFUNCTYPE(None, POINTER(Simulation)) + # _heartbeat: CFUNCTYPE(None, POINTER(Simulation)) + # _display_heartbeat: CFUNCTYPE(None, POINTER(Simulation)) + # _coefficient_of_restitution: CFUNCTYPE(float, POINTER(Simulation), float) + # _collision_resolve: CFUNCTYPE(int, POINTER(Simulation), reb_collision) + # _free_particle_ap: CFUNCTYPE(None, POINTER(Particle)) + # _extras_cleanup: CFUNCTYPE(None, POINTER(Simulation)) + extras: c_void_p + + def __new__(cls, *args: Any, **kw: Any): ... + + save_messages: int + + def __init__(self) -> None: ... + + # Deprecated methods + # @classmethod + # def from_archive(cls, filename: Any, snapshot: int = ...): ... + # + # @classmethod + # def from_file(cls, filename: Any): ... + + def copy(self) -> Simulation: ... + + def cite(self) -> None: ... + + visualization: Any = ... + + def getWidget(self, **kwargs: Any) -> Widget: ... + + def refreshWidgets(self) -> None: ... + + # not sure if those should be set manually + # simulationarchive_auto_interval: int + # simulationarchive_auto_walltime: int + # simulationarchive_auto_step: int + + def automateSimulationArchive(self, filename: str, interval: Optional[float] = ..., walltime: Optional[float] = ..., + step: Optional[int] = ..., deletefile: bool = ...) -> None: ... + + def simulationarchive_snapshot(self, filename: str, deletefile: bool = ...) -> None: ... + + @property + def simulationarchive_filename(self) -> str: ... + + def process_messages(self) -> None: ... + + def __del__(self) -> None: ... + + def __eq__(self, other: object) -> bool: ... + + def __add__(self, other: Simulation) -> Simulation: ... + + def __iadd__(self, other: Simulation) -> Simulation: ... + + def __sub__(self, other: Simulation) -> Simulation: ... + + def __isub__(self, other: Simulation) -> Simulation: ... + + def __mul__(self, other: float) -> Simulation: ... + + def __imul__(self, other: float) -> Simulation: ... + + def __rmul__(self, other: float) -> Simulation: ... + + def __div__(self, other: float) -> Simulation: ... + + def __idiv__(self, other: float) -> Simulation: ... + + def __truediv__(self, other: float) -> Simulation: ... + + def __itruediv__(self, other: float) -> Simulation: ... + + def multiply(self, scalar_pos: float, scalar_vel: float) -> None: ... + + def status(self) -> None: ... + + @property + def additional_forces(self) -> None: ... + + @additional_forces.setter + def additional_forces(self, func: Callable[[POINTER(Simulation)], None]) -> None: ... + + @property + def pre_timestep_modifications(self) -> None: ... + + @pre_timestep_modifications.setter + def pre_timestep_modifications(self, func: Callable[[POINTER(Simulation)], None]) -> None: ... + + @property + def post_timestep_modifications(self) -> None: ... + + @post_timestep_modifications.setter + def post_timestep_modifications(self, func: Callable[[POINTER(Simulation)], None]) -> None: ... + + @property + def heartbeat(self) -> None: ... + + @heartbeat.setter + def heartbeat(self, func: Callable[[POINTER(Simulation)], None]) -> None: ... + + @property + def coefficient_of_restitution(self) -> None: ... + + @coefficient_of_restitution.setter + def coefficient_of_restitution(self, func: Callable[[POINTER(Simulation), float], float]) -> None: ... + + @property + def collision_resolve(self) -> None: ... + + @collision_resolve.setter + def collision_resolve(self, func: Union[ + Literal["merge:", "hardsphere"], + Callable[[POINTER(Simulation), reb_collision], float] + ]) -> None: ... + + @property + def free_particle_ap(self) -> None: ... + + @free_particle_ap.setter + def free_particle_ap(self, func: Callable[[POINTER(Particles)], None]) -> None: ... + + @property + def N_real(self) -> int: ... + + @property + def integrator(self) -> str: ... + + @integrator.setter + def integrator(self, value: Union[int, str]) -> None: ... + + @property + def boundary(self) -> str: ... + + @boundary.setter + def boundary(self, value: Union[int, str]) -> None: ... + + @property + def gravity(self) -> str: ... + + @gravity.setter + def gravity(self, value: Union[int, str]) -> None: ... + + @property + def collision(self) -> str: ... + + @collision.setter + def collision(self, value: Union[int, str]) -> None: ... + + @property + def units(self) -> Dict[str, str]: ... + + @units.setter + def units(self, newunits: Tuple[str, str, str]) -> None: ... + + # python_unit_l: Any = ... + # python_unit_t: Any = ... + # python_unit_m: Any = ... + + def update_units(self, newunits: Tuple[str, str, str]) -> None: ... + + def convert_particle_units(self, *args: Any) -> None: ... + + def add_variation(self, order: int = ..., first_order: Optional[Variation] = ..., + first_order_2: Optional[Variation] = ..., testparticle: int = ...): ... + + def init_megno(self, seed: Optional[int] = ...) -> None: ... + + def calculate_megno(self) -> float: ... + + def calculate_lyapunov(self) -> float: ... + + #TODO: support other arguments + def add(self, particle: Optional[Particle] = ..., **kwargs: Any) -> None: ... + + @property + def particles(self) -> Particles: ... + + @particles.deleter + def particles(self) -> None: ... + + def remove(self, index: Optional[int] = ..., hash: Optional[HashType] = ..., keepSorted: bool = ...) -> None: ... + + def particles_ascii(self, prec: int = ...) -> str: ... + + def add_particles_ascii(self, s: str) -> None: ... + + def calculate_orbits(self, primary: Optional[Particle] = ..., jacobi_masses: bool = ..., + # deprecated options: + # heliocentric: Optional[bool] = ..., barycentric: Optional[bool] = ... + ) -> Orbit: ... + + def calculate_com(self, first: int = ..., last: Optional[int] = ...) -> Particle: ... + + def serialize_particle_data(self, **kwargs: Any) -> None: ... + + def set_serialized_particle_data(self, **kwargs: Any) -> None: ... + + def move_to_hel(self) -> None: ... + + def move_to_com(self) -> None: ... + + def calculate_energy(self) -> float: ... + + def calculate_angular_momentum(self) -> Tuple[float, float, float]: ... + + def configure_box(self, boxsize: float, root_nx: int = ..., root_ny: int = ..., root_nz: int = ...) -> None: ... + + def configure_ghostboxes(self, nghostx: int = ..., nghosty: int = ..., nghostz: int = ...) -> None: ... + + def save(self, filename: str) -> None: ... + + def step(self) -> None: ... + + # exact_finish_time: int = ... + + def integrate(self, tmax: float, exact_finish_time: IntBoolean = ...) -> None: ... + + def integrator_reset(self) -> None: ... + + def integrator_synchronize(self) -> None: ... + + def tree_update(self) -> None: ... + + +class Variation(Structure): + _sim: POINTER(Simulation) + order: int + index: int + testparticle: int + index_1st_order_a: int + index_1st_order_b: int + + def vary(self, particle_index: int, variation: str, variation2: Optional[str] = ..., + primary: Optional[Particle] = ...) -> None: ... + + @property + def particles(self) -> List[Particle]: ... #TODO: check if correct + + +class reb_particle_int(Structure): + x: int + y: int + z: int + vx: int + vy: int + vz: int + + +class reb_simulation_integrator_janus(Structure): + scale_pos: float + scale_vel: float + order: int + recalculate_integer_coordinates_this_timestep: IntBoolean + p_int: POINTER(reb_particle_int) + _allocated_N: int + + +class reb_simulation_integrator_eos(Structure): + _phi0: int + _phi1: int + n: int + safe_mode: IntBoolean + is_synchronized: IntBoolean + + @property + def phi0(self) -> str: ... + + @phi0.setter + def phi0(self, value: str) -> None: ... + + @property + def phi1(self) -> str: ... + + @phi1.setter + def phi1(self, value: str) -> None: ... + + +class reb_simulation_integrator_mercurius(Structure): + L: Callable[[POINTER(Simulation), float, float], float] + hillfac: float + recalculate_coordinates_this_timestep: IntBoolean + recalculate_dcrit_this_timestep: IntBoolean + safe_mode: IntBoolean + _is_synchronized: IntBoolean + mode: int + _encounterN: int + _encounterNactive: int + _allocatedN: int + _allocatedN_additionalforces: int + _dcrit_allocatedN: int + _dcrit: POINTER(float) + _particles_backup: POINTER(Particle) + _particles_backup_additionalforces: POINTER(Particle) + _encounter_map: POINTER(int) + _com_pos: reb_vec3d + _com_vel: reb_vec3d + + +class timeval(Structure): + tv_sec: int + tv_sec: int + + +#TODO: check if ctypes should be used above + +class reb_display_data(Structure): + r: POINTER(Simulation) + r_copy: POINTER(Simulation) + particle_data: c_void_p + orbit_data: c_void_p + particles_copy: POINTER(Particle) + p_jh_copy: POINTER(Particle) + allocated_N: int + allocated_N_whfast: int + opengl_enabled: int + scale: float + mouse_x: float + mouse_y: float + retina: float + + +ParticleKey = Union[c_uint32, c_uint, c_ulong, str, int] + + +class Particles(MutableMapping): + sim: Simulation + + def __init__(self, sim: Simulation) -> None: ... + + def __getitem__(self, key: ParticleKey) -> Union[Particle, List[Particle]]: ... + + def __setitem__(self, key: ParticleKey, value: Particle) -> None: ... + + def __delitem__(self, key: ParticleKey) -> None: ... + + def __iter__(self) -> Iterator[Particle]: ... + + def __len__(self) -> int: ... diff --git a/rebound/simulationarchive.pyi b/rebound/simulationarchive.pyi new file mode 100644 index 0000000..0a8f89e --- /dev/null +++ b/rebound/simulationarchive.pyi @@ -0,0 +1,38 @@ +from ctypes import Structure, c_int +from typing import Any, Optional, Callable, Sequence, Iterator, Literal, Iterable, Tuple, Union + +import numpy as np + +from rebound import Simulation +from rebound.simulation import IntBoolean + + +class SimulationArchive(Structure): + setup: Callable + setup_args: Sequence + process_warnings: bool + warnings: c_int + tmin: float + tmax: float + + def __init__(self, filename: Any, setup: Optional[Callable] = ..., setup_args: Sequence = ..., + process_warnings: bool = ..., reuse_index: Optional[SimulationArchive] = ...) -> None: ... + + def __del__(self) -> None: ... + + def __getitem__(self, key: int) -> Simulation: ... + + def __setitem__(self, key: int, value: Any) -> None: ... + + def __delitem__(self, key: int) -> None: ... + + def __iter__(self) -> Iterator[Simulation]: ... + + def __len__(self) -> int: ... + + def getSimulation(self, t: float, mode: Literal["snapshot", "close", "exact"] = ..., + keep_unsynchronized: IntBoolean = ...) -> Simulation: ... + + def getSimulations(self, times: Iterable[float], **kwargs: Any) -> Iterator[Simulation]: ... + + def getBezierPaths(self, origin: Union[None, int, Literal["com"]] = ...) -> Tuple[np.ndarray, np.ndarray]: ... diff --git a/rebound/tools.pyi b/rebound/tools.pyi new file mode 100644 index 0000000..83d1363 --- /dev/null +++ b/rebound/tools.pyi @@ -0,0 +1,6 @@ +from ctypes import c_uint32, Union, c_uint, c_ulong + +from .types import HashType + + +def hash(key: HashType) -> Union[c_uint32, c_uint, c_ulong]: ... diff --git a/rebound/types.pyi b/rebound/types.pyi new file mode 100644 index 0000000..6dcd25d --- /dev/null +++ b/rebound/types.pyi @@ -0,0 +1,4 @@ +from ctypes import c_uint32, c_ulong, c_uint +from typing import Union + +HashType = Union[c_uint32, c_uint, c_ulong, str, int] diff --git a/rebound/units.pyi b/rebound/units.pyi new file mode 100644 index 0000000..436ab5c --- /dev/null +++ b/rebound/units.pyi @@ -0,0 +1,35 @@ +from ctypes import c_uint32 +from typing import Dict, Sequence + +from rebound import Particle + + +def hash_to_unit(hash: c_uint32) -> str: ... + + +G_SI: float +times_SI: Dict[str, float] +lengths_SI: Dict[str, float] +masses_SI: Dict[str, float] + + +def units_convert_particle(p: Particle, old_l: str, old_t: str, old_m: str, + new_l: str, new_t: str, new_m: str) -> Particle: ... + + +def convert_mass(mass: float, old_m: str, new_m: str) -> float: ... + + +def convert_length(length: float, old_l: str, new_l: str) -> float: ... + + +def convert_vel(vel: float, old_l: str, old_t: str, new_l: str, new_t: str) -> float: ... + + +def convert_acc(acc: float, old_l: str, old_t: str, new_l: str, new_t: str) -> float: ... + + +def convert_G(newunits: Sequence[str]) -> float: ... + + +def check_units(newunits: Sequence[str]) -> Sequence[str]: ... diff --git a/rebound/widget.pyi b/rebound/widget.pyi new file mode 100644 index 0000000..12d2833 --- /dev/null +++ b/rebound/widget.pyi @@ -0,0 +1,38 @@ +# from . import clibrebound as clibrebound +# from ctypes import byref as byref, c_float as c_float, create_string_buffer as create_string_buffer +# from ipywidgets import DOMWidget +# from typing import Any, Optional +# +# shader_code: str +# js_code: str +# ipywidgets_major_version: Any +# +# def savescreenshot(change: Any) -> None: ... +# +# class Widget(DOMWidget): +# count: Any = ... +# screenshotcount: Any = ... +# t: Any = ... +# N: Any = ... +# overlay: Any = ... +# width: Any = ... +# height: Any = ... +# scale: Any = ... +# particle_data: Any = ... +# orbit_data: Any = ... +# orientation: Any = ... +# orbits: Any = ... +# screenshot: Any = ... +# screenshotcountall: int = ... +# autorefresh: Any = ... +# useroverlay: Any = ... +# simp: Any = ... +# def __init__(self, simulation: Any, size: Any = ..., orientation: Any = ..., scale: Optional[Any] = ..., autorefresh: bool = ..., orbits: bool = ..., overlay: bool = ...) -> None: ... +# def refresh(self, simp: Optional[Any] = ..., isauto: int = ...) -> None: ... +# archive: Any = ... +# screenshotprefix: Any = ... +# times: Any = ... +# mode: Any = ... +# def takeScreenshot(self, times: Optional[Any] = ..., prefix: str = ..., resetCounter: bool = ..., archive: Optional[Any] = ..., mode: str = ...) -> None: ... +# @staticmethod +# def getClientCode(): ... diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..79671d1 --- /dev/null +++ b/setup.py @@ -0,0 +1,29 @@ +import os + +from setuptools import setup + + +def find_stubs(package): + stubs = [] + for root, dirs, files in os.walk(package): + for file in files: + path = os.path.join(root, file).replace(package + os.sep, "", 1) + stubs.append(path) + return {package: stubs} + + +setup( + name="rebound-stubs", + maintainer="Lukas Winkler", + maintainer_email="rebound-stubs@lw1.at", + description="type stubs for Rebound", + license="GPL", + version="3.13.0", + packages=["rebound-stubs"], + # PEP 561 requires these + install_requires=[ + "rebound>=3.13.0", + ], + package_data=find_stubs("rebound-stubs"), + zip_safe=False, +)