diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..5c7550a04871a29fdcd1de5fca8b105f03ab1d71 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + 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. + + PySwiftsim + Copyright (C) 2017 Loic Hausammann + + 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 <http://www.gnu.org/licenses/>. + +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: + + PySwiftsim Copyright (C) 2017 Loic Hausammann + 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 +<http://www.gnu.org/licenses/>. + + 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 +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/pyswiftsim/__init__.py b/pyswiftsim/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..50a5cb6cd4d2eec05cc57e8c426c001cd68b2db3 --- /dev/null +++ b/pyswiftsim/__init__.py @@ -0,0 +1,2 @@ + +from pyswiftsim import * diff --git a/pyswiftsim/structure.py b/pyswiftsim/structure.py new file mode 100644 index 0000000000000000000000000000000000000000..6197a2241d1dfa038cbc64d5836fe261b1618dc5 --- /dev/null +++ b/pyswiftsim/structure.py @@ -0,0 +1,441 @@ +from pyswiftsim import wrapper + +import struct +import numpy +from ctypes import * + +PARSER_MAX_LINE_SIZE = 256 +PARSER_MAX_NO_OF_PARAMS = 256 +PARSER_MAX_NO_OF_SECTIONS = 64 + +###################################################################### +# # +# SwiftStruct # +# # +###################################################################### +class SwiftStruct(struct.Struct): + """ + Abstract class constructing a wrapper around a C structure + + Parameters + ---------- + + struct_format: str + Text defining the data type in the structure (see struct module for + more informations) + + data: str, list + Bytes string containing all the data of a structure or + dictionary of attribute (all the attribute should be present) + + parent: :class:`SwiftStruct` + Parent containing the data (usefull for :class:`ArrayStruct`) + """ + def __init__(self, struct_format, data, parent): + super().__init__(struct_format) + self.parent = parent # parent for ArrayStruct + + if isinstance(data, bytes): + self.data = data # bytes string data + elif isinstance(data, dict): + tmp = [] + for i in self.struct_name: + tmp.append(data[i]) + + self.data = self.pack(*tmp) + else: + raise ValueError("Data should be either bytes or dict, " + "received ", type(data)) + + @property + def struct_name(self): + """ + List of the structure attribute names. + + Should be implemented for each sub class + """ + return self.__class__._name + + @property + def struct_format(self): + """ + String containing the data type of each attribute + """ + return self.__class__._format + + @property + def struct_substruct(self): + """ + Dictionary containing the class of each substructure. + See for example SwiftParams + """ + return {} + + + def _getInfoFromName(self, name): + """ + Compute index, format and size from an attribute name. + + Parameters + ---------- + + name: str + Name of an attribute + + Returns + ------- + + i: int, slice + index of the attribute + + form: char + data type (see module struct for more information) + + n: int + number of element in attribute + """ + struct_size, form = self.struct_size_format + i = self.struct_name.index(name) + form = form[i] + n = struct_size[i] + i = sum(struct_size[:i]) + + if n > 1: + i = slice(i, i+n) + + return i, form, n + + + @property + def struct_size_format(self): + """ + Compute size and format for each field + + Returns + ------- + + out_nber: list + number of element for each attribute + + out_form: list + format for each attribute + """ + out_nber = [] + out_form = [] + form = self.struct_format + + N = len(form) + ii = 0 + while ii < N: + v = form[ii] + count = "" + while v.isdigit(): + count += v + ii += 1 + v = form[ii] + + if count == "": + count = 1 + + if v == "s": + count = 1 + + count = int(count) + out_nber.append(count) + out_form.append(v) + ii += 1 + + return out_nber, out_form + + + def __str__(self): + tab = "" + parent = self.parent + while parent is not None: + tab += "\t" + parent = parent.parent + + txt = tab + "%s:\n" % type(self) + for name in self.struct_name: + d = getattr(self, name) + txt += tab + "\t%s: %s\n" % (name, d) + return txt + + def __getattr__(self, name): + # case where the attribute is not in the structure + if name not in self.struct_name: + return object.__getattribute__(self, name) + + # case where the attribute is in the structure + else: + i, form, n = self._getInfoFromName(name) + + data = self.unpack(self.data) + if n == 1: + # if substruct + if name in self.struct_substruct: + d = self.struct_substruct[name] + cl = d["class"] + tmp = [] + size = struct.calcsize(cl._format) + for j in range(d["size"]): + data_tmp = data[i][size*j:(j+1)*size] + tmp.append(cl(data_tmp, parent=self)) + return tmp + # other case => array + else: + return data[i] + + else: + # transform scalar -> vector + nform = str(n) + form + i = slice(i.start, i.start+n) + data = data[i] + + # compress data and create return struct + data = struct.pack(nform, *data) + return ArrayStruct(nform, data, self, name) + + + def __setattr__(self, name, value): + # case where the attribute is not in the structure + if name not in self.struct_name: + object.__setattr__(self, name, value) + # case where the attribute is in the structure + else: + data = list(self.unpack(self.data)) + + i, form, n = self._getInfoFromName(name) + + if isinstance(value, ArrayStruct): + value = value.getArray() + + data[i] = value + self.data = self.pack(*data) + + +###################################################################### +# # +# ArrayStruct # +# # +###################################################################### +class ArrayStruct(SwiftStruct): + _name = [ + "array_data" + ] + + def __init__(self, struct_format, data, parent, name): + super().__init__(struct_format, data, parent) + self._format = struct_format + self._name = name + + def __getitem__(self, ii): + data = self.unpack(self.data) + data = self._clean(data) + return data[ii] + + def __setitem__(self, ii, value): + data = list(self.unpack(self.data)) + data[ii] = value + setattr(self.parent, self._name, data) + + def _clean(self, data): + if self._format[-1] == "c": + data = b"".join(data) + # find end of txt character + n = data.index(b"\x00") + data = data[:n].decode("utf-8") + + return data + + def __str__(self): + data = self.unpack(self.data) + data = self._clean(data) + return str(data) + + + def getArray(self): + return self.unpack(self.data) + + @property + def struct_format(self): + return self._format + + +###################################################################### +# # +# UnitSystem # +# # +###################################################################### +class UnitSystem(SwiftStruct): + _format = "ddddd" + _name = [ + "UnitMass_in_cgs", + "UnitLength_in_cgs", + "UnitTime_in_cgs", + "UnitCurrent_in_cgs", + "UnitTemperature_in_cgs", + ] + + def __init__(self, data, parent=None): + super().__init__(self.struct_format, data, parent) + + +###################################################################### +# # +# Part # +# # +###################################################################### +class Part(SwiftStruct): + _format = "qP3d3f3ffffffN7f4c" + _name = [ + "id", + "gpart", + "pos", + "vel", + "a_hydro", + "h", + "mass", + "rho", + "entropy", + "entropy_dt", + "last_offset", + "density", + "time_bin" + ] + + def __init__(self, data, parent=None): + super().__init__(self.struct_format, data, parent) + print("ERROR, need to fix density/time_bin") + + +###################################################################### +# # +# Parameter # +# # +###################################################################### +class Parameter(SwiftStruct): + _format = "{line_size}c{line_size}c".format( + line_size=PARSER_MAX_LINE_SIZE + ) + + _name = [ + "name", + "value" + ] + + + def __init__(self, data, parent=None): + super().__init__(self.struct_format, data, parent) + +###################################################################### +# # +# Section # +# # +###################################################################### +class Section(SwiftStruct): + _format = "{line_size}c".format( + line_size=PARSER_MAX_LINE_SIZE + ) + _name = [ + "name" + ] + + def __init__(self, data, parent=None): + super().__init__(self.struct_format, data, parent) + +###################################################################### +# # +# SwiftParams # +# # +###################################################################### +class SwiftParams(SwiftStruct): + _format = "{sec}s{data}sii{line_size}c".format( + sec=struct.calcsize(Section._format)*PARSER_MAX_NO_OF_SECTIONS, + data=struct.calcsize(Parameter._format)*PARSER_MAX_NO_OF_PARAMS, + line_size=PARSER_MAX_LINE_SIZE + ) + + _name = [ + "section", + "data_params", + "sectionCount", + "paramCount", + "filename" + ] + + def __init__(self, data, parent=None): + super().__init__(self.struct_format, data, parent) + + @property + def struct_substruct(self): + sec = { + "class": Section, + "size": PARSER_MAX_NO_OF_SECTIONS + } + + param = { + "class": Parameter, + "size": PARSER_MAX_NO_OF_PARAMS + } + return { + "section": sec, + "data_params": param + } + +###################################################################### +# # +# PhysConst # +# # +###################################################################### +class PhysConst(SwiftStruct): + _format = "dddddddddddddddd" + _name = [ + "const_newton_G", + "const_speed_light_c", + "const_planck_h", + "const_planck_hbar", + "const_boltzmann_k", + "const_thomson_cross_section", + "const_electron_charge", + "const_electron_volt", + "const_electron_mass", + "const_proton_mass", + "const_year", + "const_astronomical_unit", + "const_parsec", + "const_light_year", + "const_solar_mass", + "const_earth_mass", + ] + + + def __init__(self, data, parent=None): + super().__init__(self.struct_format, data, parent) + + +class CoolingFunctionData(SwiftStruct): + cooling_type = wrapper.configGetCooling() + if cooling_type == "const_lambda": + _format = "dffff" + _name = [ + "lambda", + "hydrogen_mass_abundance", + "mean_molecular_weight", + "min_energy", + "cooling_tstep_mult" + ] + elif cooling_type == "grackle": + _format = "200cidd" + _name = [ + "GrackleCloudyTable", + "UVbackground", + "GrackleRedshift", + "GrackleHSShieldingDensityThreshold" + ] + else: + raise ValueError( + "Cooling Type %s not implemented" % cooling_type) + + def __init__(self, data, parent=None): + super().__init__(self.struct_format, data, parent) diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000000000000000000000000000000000..3efb6897a93e83a649044df5aab442b22b33769d --- /dev/null +++ b/setup.py @@ -0,0 +1,140 @@ +#!/usr/bin/env python3 + +descr = """ +Wrapper around the SPH cosmological simulation code SWIFT +""" + +from setuptools import setup, find_packages, Extension +import sys +import os +from glob import glob +import numpy + +os.environ["CC"] = "mpicc" + +# deal with arguments +def parseCmdLine(arg, store=False): + ret = False + if arg in sys.argv: + if store: + i = sys.argv.index(arg) + ret = sys.argv[i+1] + sys.argv.remove(ret) + else: + ret = True + + sys.argv.remove(arg) + + return ret + +swift_path = parseCmdLine("--with-swift", store=True) + +# python lib dependency +install_requires=["numpy"] + + +def getValueFromMakefile(swift_root, value): + makefile = swift_root + "/src/Makefile" + N = len(value) + + with open(makefile, "r") as f: + for line in f.readlines(): + if value == line[:N]: + return line[N:-1] # remove \n + + raise ValueError("Value %s not found in Makefile" % value) + + +if swift_path: + hdf5_root = getValueFromMakefile(swift_path, "H5CC = ") + +# link to non pypi dependencies +dependency_links = [] + +# C includes +include = [numpy.get_include()] + +if swift_path: + # swift + include.extend([ + swift_path + "/src", + swift_path + ]) + + # hdf5 + include.append(hdf5_root + "/include") + + # grackle + grackle_inc = getValueFromMakefile(swift_path, "GRACKLE_INCS = -I") + include.append(grackle_inc) + +# C libraries +lib = ["m", + "swiftsim", + "hdf5", +] + +lib_dir = [] + +if swift_path: + lib_dir.append(swift_path + "/src/.libs") + lib_dir.append(hdf5_root + "/lib") + +# src files +c_src = [] + +# data files +data_files = [] + + +############## +## C ext +############## + +c_src = glob("src/*.c") +ext_modules = Extension("pyswiftsim.wrapper", + c_src, + include_dirs=include, + libraries=lib, + library_dirs=lib_dir) + +ext_modules = [ext_modules] + +############## +## data +############## + +data_files = [] + +############## +## scripts +############## + +list_scripts = [] + +############## +## Setup +############## + +setup( + name = "pyswiftsim", + version = "0.1", + author = "Hausammann Loic", + author_email = "loic.hausammann@epfl.ch", + description = descr, + license = "GPLv3", + keywords = "nbody sph simulation hpc", + url = "", + + packages = find_packages(), + + data_files = data_files, + + scripts = list_scripts, + + install_requires = install_requires, + + dependency_links = dependency_links, + + ext_modules = ext_modules, +) diff --git a/src/config_wrapper.h b/src/config_wrapper.h new file mode 100644 index 0000000000000000000000000000000000000000..bc84738cd80c204ab003f74da0539bd6a19156c6 --- /dev/null +++ b/src/config_wrapper.h @@ -0,0 +1,24 @@ +#ifndef __PYSWIFTSIM_CONFIG_H__ +#define __PYSWIFTSIM_CONFIG_H__ + +#include "pyswiftsim_tools.h" + +#include <config.h> + +/** + * @brief give the cooling type name + * + * @return Cooling name (PyUnicode) + */ +PyObject* config_get_cooling() { + char *cooling_name; +#ifdef COOLING_CONST_LAMBDA + cooling_name = "const_lambda"; +#elif defined(COOLING_GRACKLE) + cooling_name = "grackle"; +#endif + return PyUnicode_FromString(cooling_name); +}; + + +#endif // __PYSWIFTSIM_CONFIG_H__ diff --git a/src/cooling_wrapper.c b/src/cooling_wrapper.c new file mode 100644 index 0000000000000000000000000000000000000000..49d6592c4cb9d4f63a61633e21f8dbedbc7379e8 --- /dev/null +++ b/src/cooling_wrapper.c @@ -0,0 +1,124 @@ +#include "pyswiftsim_tools.h" +#include "cooling_wrapper.h" + +#include <cooling.h> +#include <cooling_struct.h> +#include <equation_of_state.h> + + +#include <numpy/arrayobject.h> + + +PyObject* pycooling_init(PyObject* self, PyObject* args) { + PyObject *pyparams; + PyObject *pyus; + PyObject *pypconst; + + /* parse arguments */ + if (!PyArg_ParseTuple(args, "OOO", &pyparams, &pyus, &pypconst)) + return NULL; + + struct swift_params *params = (struct swift_params*) pytools_construct(pyparams, class_swift_params); + if (params == NULL) + return NULL; + + struct unit_system *us = (struct unit_system*) pytools_construct(pyus, class_unit_system); + if (us == NULL) + return NULL; + + struct phys_const *pconst = (struct phys_const*) pytools_construct(pypconst, class_phys_const); + if (pconst == NULL) + return NULL; + + + struct cooling_function_data cooling; + + /* init cooling */ + cooling_init_backend(params, us, pconst, &cooling); + + /* construct python object */ + PyObject *pycooling = pytools_return(&cooling, class_cooling_function_data); + + return pycooling; +} + +PyArrayObject* pycooling_rate(PyObject* self, PyObject* args) { + IMPORT_ARRAY(); + + PyObject *pycooling; + PyObject *pyus; + PyObject *pypconst; + + PyArrayObject *rho; + PyArrayObject *energy; + + float dt = 1e-3; + + /* parse argument */ + if (!PyArg_ParseTuple(args, + "OOOOO|f", + &pypconst, + &pyus, + &pycooling, + &rho, + &energy, + &dt)) + return NULL; + + /* check numpy array */ + if (pytools_check_array(energy, 1, NPY_FLOAT) != SUCCESS) + { + return NULL; + } + + if (pytools_check_array(rho, 1, NPY_FLOAT) != SUCCESS) + { + return NULL; + } + + if (PyArray_DIM(energy, 0) != PyArray_DIM(rho, 0)) + { + pyerror("Density and energy should have the same dimension"); + } + + size_t N = PyArray_DIM(energy, 0); + + /* transform PyObject to C struct */ + + struct cooling_function_data *cooling = (struct cooling_function_data*) pytools_construct(pycooling, class_cooling_function_data); + if (cooling == NULL) + return NULL; + + struct unit_system *us = (struct unit_system*) pytools_construct(pyus, class_unit_system); + if (us == NULL) + return NULL; + + struct phys_const *pconst = (struct phys_const*) pytools_construct(pypconst, class_phys_const); + if (pconst == NULL) + return NULL; + + struct part p; + + /* return object */ + PyArrayObject *rate = PyArray_NewLikeArray(energy, NPY_ANYORDER, NULL, 1); + + /* loop over all particles */ + for(size_t i = 0; i < N; i++) + { + /* set particle data */ + p.rho = *(float*) PyArray_GETPTR1(rho, i); + float u = *(float*) PyArray_GETPTR1(energy, i); + p.entropy = gas_entropy_from_internal_energy(p.rho, u); + + /* compute cooling rate */ + float *tmp = PyArray_GETPTR1(rate, i); +#ifdef COOLING_GRACKLE + *tmp = cooling_rate(pconst, us, cooling, &p, dt); +#else + *tmp = cooling_rate(pconst, us, cooling, &p); +#endif + } + + return rate; + +} diff --git a/src/cooling_wrapper.h b/src/cooling_wrapper.h new file mode 100644 index 0000000000000000000000000000000000000000..4fbdd8abbc746d5d42aa4e32baa707c7770aa602 --- /dev/null +++ b/src/cooling_wrapper.h @@ -0,0 +1,33 @@ +#ifndef __PYSWIFTSIM_COOLING_H__ +#define __PYSWIFTSIM_COOLING_H__ + +#include "pyswiftsim_tools.h" + +/** + * @brief Initialize the cooling + * + * args is expecting pyswiftsim classes in the following order: + * SwiftParams, UnitSystem and PhysConst. + * + * @param self calling object + * @param args arguments + * @return CoolingFunctionData + */ +PyObject* pycooling_init(PyObject* self, PyObject* args); + +/** + * @brief Compute cooling rate + * + * args is expecting pyswiftsim classes in the following order: + * PhysConst, UnitSystem and CoolingFunctionData. + * Then two numpy arrays (density and specific energy) and an optional + * float for the time step + * + * @param self calling object + * @param args arguments + * @return cooling rate + */ +PyArrayObject* pycooling_rate(PyObject* self, PyObject* args); + +#endif // __PYSWIFTSIM_COOLING_H__ + diff --git a/src/parser_wrapper.c b/src/parser_wrapper.c new file mode 100644 index 0000000000000000000000000000000000000000..ef164f58389ef5d3d2ecbce0de2e4aec081b2736 --- /dev/null +++ b/src/parser_wrapper.c @@ -0,0 +1,24 @@ +#include "parser_wrapper.h" +#include "pyswiftsim_tools.h" + +#include <parser.h> + +PyObject* pyparser_read_file(PyObject *self, PyObject *args) +{ + + char *filename; + + /* parse argument */ + if (!PyArg_ParseTuple(args, "s", &filename)) + return NULL; + + struct swift_params params; + + /* parse file */ + parser_read_file(filename, ¶ms); + + /* create return python object */ + PyObject* obj = pytools_return(¶ms, class_swift_params); + + return obj; +} diff --git a/src/parser_wrapper.h b/src/parser_wrapper.h new file mode 100644 index 0000000000000000000000000000000000000000..529d352a7698f9180688033ca913efd870ddd272 --- /dev/null +++ b/src/parser_wrapper.h @@ -0,0 +1,18 @@ +#ifndef __PYSWIFTSIM_PARSER_H__ +#define __PYSWIFTSIM_PARSER_H__ + +#include <Python.h> + +/** + * @brief Read swift parameters + * + * args is expecting a string. + * + * @param self calling object + * @param args arguments + * @return SwiftParams + */ +PyObject* pyparser_read_file(PyObject *self, PyObject *args); + + +#endif // __PYSWIFTSIM_PARSER_H__ diff --git a/src/part_wrapper.c b/src/part_wrapper.c new file mode 100644 index 0000000000000000000000000000000000000000..a4765eecae376cd000fb4c4850bee4b420cd8b0a --- /dev/null +++ b/src/part_wrapper.c @@ -0,0 +1,40 @@ +#include "pyswiftsim_tools.h" + +#include <part.h> +#include <hydro.h> + +#include <Python.h> +#include <stdlib.h> +#include <string.h> + +PyObject* pypart_test_struct(PyObject *self, PyObject *args) +{ + + size_t N = sizeof(struct part); + + /* initialize particle */ + struct part *p = malloc(N); + p->id = 0; + for(size_t k = 0; k < DIM; k++) + { + p->x[k] = 1. + k; + p->v[k] = 4. + k; + p->a_hydro[k] = 7. + k; + } + + p->h = 10; + p->mass = 11.; + p->rho = 12.; + p->entropy = 13; + p->entropy_dt = 14; + + hydro_init_part(p, NULL); + + /* create python object */ + PyObject *object = pytools_return(p, class_part); + + free(p); + + return object; +} + diff --git a/src/part_wrapper.h b/src/part_wrapper.h new file mode 100644 index 0000000000000000000000000000000000000000..58a426fa48a57c6c88dc591df01754ffe8ea8e91 --- /dev/null +++ b/src/part_wrapper.h @@ -0,0 +1,18 @@ +#ifndef __PYSWIFTSIM_PART_H__ +#define __PYSWIFTSIM_PART_H__ + +#include <Python.h> +#include <part.h> + +/** + * @brief Test function for the struct + * + * args is expecting no argument. + * + * @param self calling object + * @param args arguments + * @return Part + */ +PyObject* pypart_test_struct(PyObject *self, PyObject *args); + +#endif // __PYSWIFTSIM_PART_H__ diff --git a/src/pyswiftsim_tools.c b/src/pyswiftsim_tools.c new file mode 100644 index 0000000000000000000000000000000000000000..41814598be72886abeb35ca6a750fb59b3748a1e --- /dev/null +++ b/src/pyswiftsim_tools.c @@ -0,0 +1,207 @@ +#include "pyswiftsim_tools.h" + +/* include swift */ +#include <part.h> +#include <units.h> +#include <parser.h> +#include <physical_constants.h> +#include <cooling_struct.h> + +#include <Python.h> +#include <numpy/arrayobject.h> + + +const size_t class_size[class_count] = { + sizeof(struct unit_system), + sizeof(struct part), + sizeof(struct swift_params), + sizeof(struct phys_const), + sizeof(struct cooling_function_data) +}; + +const char *class_name[class_count] = { + "UnitSystem", + "Part", + "SwiftParams", + "PhysConst", + "CoolingFunctionData" +}; + + +PyObject* pytools_import(char* module_name, char* object_name) +{ + /* load module */ + PyObject *module; + + module = PyImport_ImportModule(module_name); + + if (module == NULL) + { + pyerror("Failed to import module '%s'.", module_name); + } + + /* get module dictionary */ + PyObject *dict; + + dict = PyModule_GetDict(module); + Py_DECREF(module); + + if (dict == NULL) + { + pyerror("Failed to get module '%s' dictionary", module_name); + } + + /* get right object */ + PyObject *python_obj = PyDict_GetItemString(dict, object_name); + Py_DECREF(dict); + + if (python_obj == NULL) + pyerror("Object %s does not exist in module %s", object_name, module_name); + + return python_obj; +} + + +PyObject* pytools_return(void *p, int class) +{ + + PyObject *python_class; + size_t nber_bytes; + + char module_name[STRING_SIZE] = "pyswiftsim.structure"; + char *class_pyname; + + /* check class */ + if (class >= class_count) + pyerror("Class %i does not exists", class); + + /* get class information */ + nber_bytes = class_size[class]; + class_pyname = class_name[class]; + + /* import python class */ + python_class = pytools_import(module_name, class_pyname); + + if (python_class == NULL) + return NULL; + + if (!PyCallable_Check(python_class)) + { + Py_DECREF(python_class); + pyerror("Unable to import class %s from %s", class_pyname, module_name); + } + + /* create object */ + PyObject *object, *args; + + args = PyTuple_Pack(1, PyBytes_FromStringAndSize((char *) p, nber_bytes)); + + object = PyObject_CallObject(python_class, args); + + Py_DECREF(args); + Py_DECREF(python_class); + + return object; + +} + +char* pytools_get_type_name(PyObject *obj) +{ + /* get object type */ + PyObject *type = PyObject_Type(obj); + if (type == NULL) + { + Py_DECREF(type); + pyerror("Unable to get type"); + } + + /* get object name */ + PyObject* recv = PyObject_Str(type); + Py_DECREF(type); + + if (recv == NULL) + { + Py_DECREF(recv); + pyerror("Unable to get string representation"); + } + + /* transform to C */ + size_t size; + char *name = PyUnicode_AsUTF8AndSize(recv, size); + Py_DECREF(recv); + + if (name == NULL) + { + pyerror("Unable to convert string to char"); + } + + return name; +} + + +char* pytools_construct(PyObject* obj, int class) +{ + char *module_name = "pyswiftsim.structure"; + char *class_pyname; + + /* check python class */ + if (class >= class_count) + pyerror("Class %i does not exists", class); + + /* get class information */ + class_pyname = class_name[class]; + + /* import class */ + PyObject *pyclass = pytools_import(module_name, class_pyname); + + /* check if classes correspond */ + int test = !PyObject_IsInstance(obj, pyclass); + Py_DECREF(pyclass); + if (test) + { + char *recv = pytools_get_type_name(obj); + if (recv == NULL) + return NULL; + pyerror("Expecting class %s, received %s", class_pyname, recv); + } + + + /* copy python class' data to C */ + PyObject* data = PyObject_GetAttrString(obj, "data"); + + if (data == NULL) + pyerror("Unable to get the attribute 'data'"); + + char *ret = PyBytes_AsString(data); + + Py_DECREF(data); + return ret; +} + + +int pytools_check_array(PyArrayObject *obj, int dim, int type) +{ + /* ensure to have numpy arrays */ + IMPORT_ARRAY(); + + /* check if array */ + if (!PyArray_Check(obj)) + { + pyerror("Expecting a numpy array"); + } + + /* check if required dim */ + if (PyArray_NDIM(obj) != dim) + { + pyerror("Array should be a %i dimensional object", dim); + } + + /* check data type */ + if (PyArray_TYPE(obj) != type) + { + pyerror("Wrong array type"); + } + + return SUCCESS; + +} diff --git a/src/pyswiftsim_tools.h b/src/pyswiftsim_tools.h new file mode 100644 index 0000000000000000000000000000000000000000..9d03af9f77ade6f241bcf93c2252464fc9ae0e10 --- /dev/null +++ b/src/pyswiftsim_tools.h @@ -0,0 +1,107 @@ +#ifndef __PYSWIFTSIM_TOOLS_H__ +#define __PYSWIFTSIM_TOOLS_H__ + +#define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION + +#include <Python.h> +#include <numpy/arrayobject.h> + +#define DIM 3 +#define STRING_SIZE 200 + +/* Check if arrays are imported and if not import them */ +#define IMPORT_ARRAY() \ + ({ \ + if (PyArray_API == NULL) \ + { \ + import_array(); \ + } \ + }) + +/* Set the error message for python (still need to return NULL) */ +#define pyerror(s, ...) \ + ({ \ + char error_msg[STRING_SIZE]; \ + PyErr_Print(); \ + sprintf(error_msg, "\n%s:%s():%i: " s, __FILE__, \ + __FUNCTION__, __LINE__, ##__VA_ARGS__); \ + PyErr_SetString(PyExc_RuntimeError, error_msg); \ + return FAIL; \ + }) + +/* debugging function */ +#define pydebug(s, ...) \ + ({ \ + PyErr_Print(); \ + fprintf(stderr, "\n%s:%s():%i: Test " s "\n", __FILE__, \ + __FUNCTION__, __LINE__, ##__VA_ARGS__); \ + }) + +/* Enum swift classes */ +enum swift_class { + class_unit_system, + class_part, + class_swift_params, + class_phys_const, + class_cooling_function_data, + class_count /* should always be last! */ +}; + +/* size of each structure in enum swift_class */ +extern const size_t class_size[]; +/* name of each Python class representing a swift class */ +extern const char *class_name[]; + +/* error code in pyswiftsim */ +enum error_code { + FAIL = 0, // ensure NULL == FAIL + SUCCESS, +}; + + +/** + * @brief Construct a python object from a C struct + * + * @param p pointer to the C struct + * @param class #swift_class of the pointer + * @return PyObject of the required class + */ +PyObject* pytools_return(void* p, int class); + +/** + * @brief Construct a C struct from a python object + * + * @param obj pointer to the python object + * @param class #swift_class of the pointer + * @return pointer to the required struct + */ +char* pytools_construct(PyObject* obj, int class); + +/** + * @brief Import a python library/function + * + * @param module Module name + * @param object_name object to import from module + * @return (PyObject) imported object + */ +PyObject* pytools_import(char* module, char* object_name); + +/** + * @brief get type name in C + * + * @param obj PyObject from which to get the name0 + * @return type name + */ +char* pytools_get_type_name(PyObject *obj); + +/** + * @brief Check if object is the expected PyArray type + * + * @param obj PyArray to check + * @param dim required dimension + * @param int required type + * @return #error_code result of the test + */ +int pytools_check_array(PyArrayObject *obj, int dim, int type); + +#endif // __PYSWIFTSIM_TOOLS_H__ diff --git a/src/units_wrapper.c b/src/units_wrapper.c new file mode 100644 index 0000000000000000000000000000000000000000..aeda170ac6f6e74e55ce10e0c11c637ae3621778 --- /dev/null +++ b/src/units_wrapper.c @@ -0,0 +1,66 @@ +#include "pyswiftsim_tools.h" + +#include <units.h> +#include <parser.h> +#include <physical_constants.h> + +#include <Python.h> +#include <stdlib.h> +#include <string.h> + +PyObject* pyunit_system_test_struct(PyObject *self, PyObject *args) +{ + + size_t N = sizeof(struct unit_system); + + /* initialize array */ + struct unit_system *us = malloc(N); + us->UnitMass_in_cgs = 1.; + us->UnitLength_in_cgs = 2.; + us->UnitTime_in_cgs = 3.; + us->UnitCurrent_in_cgs = 4.; + us->UnitTemperature_in_cgs = 5.; + + /* construct python object */ + PyObject *object = pytools_return(us, class_unit_system); + free(us); + if (object == NULL) + return NULL; + + return object; +} + +PyObject* pyunit_system_init(PyObject *self, PyObject *args) +{ + PyObject* parser; + + /* parse arguement */ + if (!PyArg_ParseTuple(args, "O", &parser)) + return NULL; + + struct swift_params *params = pytools_construct(parser, class_swift_params); + + if (params == NULL) + return NULL; + + /* initialize units */ + struct unit_system us; + units_init(&us, params, "InternalUnitSystem"); + + /* initialize phys_const */ + struct phys_const pconst; + phys_const_init(&us, &pconst); + + /* create python object to return */ + PyObject *pyus = pytools_return(&us, class_unit_system); + if (pyus == NULL) + return NULL; + + PyObject *pypconst = pytools_return(&pconst, class_phys_const); + if (pypconst == NULL) + return NULL; + + return PyTuple_Pack(2, pyus, pypconst); +} + + diff --git a/src/units_wrapper.h b/src/units_wrapper.h new file mode 100644 index 0000000000000000000000000000000000000000..867e055863d24203dbfb41213ef6fd837252a28e --- /dev/null +++ b/src/units_wrapper.h @@ -0,0 +1,28 @@ +#ifndef __PYSWIFTSIM_UNITS_H__ +#define __PYSWIFTSIM_UNITS_H__ + +#include <Python.h> + +/** + * @brief Test function for the struct + * + * args is expecting no argument. + * + * @param self calling object + * @param args arguments + * @return UnitSystem + */ +PyObject* pyunit_system_test_struct(PyObject *self, PyObject *args); + +/** + * @brief Initialize the unit system + * + * args is expecting a pyswift SwiftParms object. + * + * @param self calling object + * @param args arguments + * @return UnitSystem + */ +PyObject* pyunit_system_init(PyObject *self, PyObject *args); + +#endif // __PYSWIFTSIM_UNITS_H__ diff --git a/src/wrapper.c b/src/wrapper.c new file mode 100644 index 0000000000000000000000000000000000000000..27fc59183559641a6b0d3fbfa1e59011b16eae92 --- /dev/null +++ b/src/wrapper.c @@ -0,0 +1,68 @@ +#include "units_wrapper.h" +#include "part_wrapper.h" +#include "parser_wrapper.h" +#include "cooling_wrapper.h" +#include "pyswiftsim_tools.h" +#include "config_wrapper.h" + + +#include <Python.h> +#include <math.h> +#include <numpy/arrayobject.h> + + +/* definition of the method table */ + +static PyMethodDef wrapper_methods[] = { + + {"partTestStruct", pypart_test_struct, METH_VARARGS, + "Construct a part object and return it."}, + + {"unitSystemTestStruct", pyunit_system_test_struct, METH_VARARGS, + "Construct a unit_system object and return it."}, + + {"parserReadFile", pyparser_read_file, METH_VARARGS, + "Read a swift params file."}, + + {"unitSystemInit", pyunit_system_init, METH_VARARGS, + "Construct a unit_system object and return it."}, + + {"coolingInit", pycooling_init, METH_VARARGS, + "Initialize cooling."}, + + {"coolingRate", pycooling_rate, METH_VARARGS, + "Compute the cooling rate."}, + + {"configGetCooling", config_get_cooling, METH_VARARGS, + "Get the cooling type."}, + + {NULL, NULL, 0, NULL} /* Sentinel */ +}; + + + +static struct PyModuleDef wrapper_cmodule = { + PyModuleDef_HEAD_INIT, + "wrapper", + "Wrapper around the SPH cosmological simulation code SWIFT", + -1, + wrapper_methods +}; + + +PyMODINIT_FUNC PyInit_wrapper(void) +{ + PyObject *m; + + /* set time for swift */ + clocks_set_cpufreq(0); + + import_array(); + Py_Initialize(); + m = PyModule_Create(&wrapper_cmodule); + + if (m == NULL) + return NULL; + + return m; +} diff --git a/test/cooling.yml b/test/cooling.yml new file mode 100644 index 0000000000000000000000000000000000000000..96555e68c238897b81b856a624468385f0f9af90 --- /dev/null +++ b/test/cooling.yml @@ -0,0 +1,51 @@ +# Define the system of units to use internally. +InternalUnitSystem: + UnitMass_in_cgs: 1.989e43 # Grams + UnitLength_in_cgs: 3.085e21 # Centimeters + UnitVelocity_in_cgs: 20725573.785998672 # Centimeters per second + UnitCurrent_in_cgs: 1 # Amperes + UnitTemp_in_cgs: 1 # Kelvin + +# Parameters governing the time integration +TimeIntegration: + time_begin: 0. # The starting time of the simulation (in internal units). + time_end: 5e-2 # The end time of the simulation (in internal units). + dt_min: 1e-7 # The minimal time-step size of the simulation (in internal units). + dt_max: 1e-4 # The maximal time-step size of the simulation (in internal units). + +# Parameters governing the snapshots +Snapshots: + basename: sedov # Common part of the name of output files + time_first: 0. # Time of the first output (in internal units) + delta_time: 1e-2 # Time difference between consecutive outputs (in internal units) + +# Parameters governing the conserved quantities statistics +Statistics: + delta_time: 1e-3 # Time between statistics output + tasks_per_cell: 1000 + +# Parameters for the hydrodynamics scheme +SPH: + resolution_eta: 1.2348 # Target smoothing length in units of the mean inter-particle separation (1.2348 == 48Ngbs with the cubic spline kernel). + CFL_condition: 0.1 # Courant-Friedrich-Levy condition for time integration. + +# Parameters related to the initial conditions +InitialConditions: + file_name: ./sedov.hdf5 # The file to read + h_scaling: 3.33 + + +# Cooling with Grackle 2.0 +GrackleCooling: + GrackleCloudyTable: CloudyData_UVB=HM2012.h5 # Name of the Cloudy Table + UVbackground: 1 # Enable or not the UV background + GrackleRedshift: 0 # Redshift to use (-1 means time based redshift) + GrackleHSShieldingDensityThreshold: 1.1708e-26 # self shielding threshold in internal system of units + +Gravity: + eta: 0.025 # Constant dimensionless multiplier for time integration. + theta: 0.7 # Opening angle (Multipole acceptance criterion) + epsilon: 0.1 # Softening length (in internal units). + a_smooth: 1.25 # (Optional) Smoothing scale in top-level cell sizes to smooth the long-range forces over (this is the default value). + r_cut_max: 4.5 # (Optional) Cut-off in number of top-level cells beyond which no FMM forces are computed (this is the default value). + r_cut_min: 0.1 # (Optional) Cut-off in number of top-level cells below which no truncation of FMM forces are performed (this is the default value). diff --git a/test/test_cooling.py b/test/test_cooling.py new file mode 100644 index 0000000000000000000000000000000000000000..43148ce9a7e875bf9a747afc8e7847d605a3c845 --- /dev/null +++ b/test/test_cooling.py @@ -0,0 +1,136 @@ +#!/usr/bin/env python3 + +from pyswiftsim import wrapper +from pyswiftsim import structure + +from copy import deepcopy +import numpy as np +import matplotlib.pyplot as plt +from astropy import units + +# +# parameters +# + +# adiabatic index +gamma = 5. / 3. + +# swift params filename +filename = "test/cooling.yml" + +# number of points +N_rho = 300 +N_T = 300 + +# density in atom / cm3 +if N_rho == 1: + rho = np.array([1.]) +else: + #rho = np.array([1.]) + rho = np.logspace(-6, 4, N_rho) + +# temperature in K +T = np.logspace(1, 9, N_T) + +# time step +dt = units.Myr * 1e-5 +dt = dt.to("s") / units.s + + + +# generate grid +rho, T = np.meshgrid(rho, T) +shape = rho.shape +rho = deepcopy(rho.reshape(-1)) +T = T.reshape(-1) + +# +# swift init +# + +# parse swift params +params = wrapper.parserReadFile(filename) +# init units +us, pconst = wrapper.unitSystemInit(params) +# init cooling +cooling = wrapper.coolingInit(params, us, pconst) + + +# +# Deal with units +# + +# change units of rho and T +# rho +rho *= us.UnitLength_in_cgs**3 * pconst.const_proton_mass +# specific energy +energy = pconst.const_boltzmann_k * T / us.UnitTemperature_in_cgs +energy /= (gamma - 1.) * pconst.const_proton_mass +# time step +dt /= us.UnitTime_in_cgs + +# +# compute rate +# + +# du / dt +rate = wrapper.coolingRate(pconst, us, cooling, + rho.astype(np.float32), + energy.astype(np.float32), + dt) + +# +# plot +# + + +# change units => cgs +energy *= us.UnitLength_in_cgs**2 / us.UnitTime_in_cgs**2 + +rate *= us.UnitLength_in_cgs**2 / us.UnitTime_in_cgs**3 + +if N_rho == 1 or N_T == 1: + plt.figure() + n = rho / (pconst.const_proton_mass * us.UnitLength_in_cgs**3) + proton_mass_in_cgs = pconst.const_proton_mass * us.UnitMass_in_cgs + lambda_ = rate * proton_mass_in_cgs / (n) + + if N_rho == 1: + plt.loglog(T, np.abs(lambda_)) + plt.xlabel("Temperature [K]") + else: + plt.loglog(rho, np.abs(lambda_)) + plt.xlabel("Density [atom / cm3]") + plt.ylabel("Rate") + +else: + cooling_time = energy / rate + cooling_length = np.sqrt(gamma * (gamma-1.) * energy) * cooling_time + + cooling_length = np.log10(np.abs(cooling_length) / units.kpc.to('cm')) + + # reshape + rho = rho.reshape(shape) + T = T.reshape(shape) + energy = energy.reshape(shape) + cooling_length = cooling_length.reshape(shape) + + _min = -7 + _max = 7 + N_levels = 100 + levels = np.linspace(_min, _max, N_levels) + plt.figure() + plt.contourf(rho, T, cooling_length, levels) + plt.xlabel("Density [atom/cm3]") + plt.ylabel("Temperature [K]") + + ax = plt.gca() + ax.set_xscale("log") + ax.set_yscale("log") + + cbar = plt.colorbar() + tc = np.arange(_min, _max, 1.5) + cbar.set_ticks(tc) + cbar.set_ticklabels(tc) + +plt.show() diff --git a/test/test_struct.py b/test/test_struct.py new file mode 100644 index 0000000000000000000000000000000000000000..7c228d849979d2229cfd9d741862f54535f63744 --- /dev/null +++ b/test/test_struct.py @@ -0,0 +1,46 @@ +#!/usr/bin/env python3 + +from pyswiftsim import wrapper +from pyswiftsim import structure + +us = wrapper.unitSystemTestStruct() + +print(us) + +part = wrapper.partTestStruct() + +print(part) + +#us = structure.Units(t) + +#print(type(us), us.struct_name) +#print(us.struct_size_format) + +#for i in us.struct_name: +# print(i, getattr(us, i)) + +""" +print(us.pos) +us.pos = [12., 16., 11.] +#us.pos[0] = 10. + +print(us) +print(us.pos) + +print("setitem") +us.pos[2] = 20. + +print(us.pos) +print(us) + +d = {} +d["UnitMass_in_cgs"] = 1. +d["UnitLength_in_cgs"] = 2. +d["UnitTime_in_cgs"] = 3. +d["UnitCurrent_in_cgs"] = 4. +d["UnitTemperature_in_cgs"] = 5. + +us = structure.UnitSystem(d) + +print(us) +"""