From e54ab1564cda51c0ffb4b4cb37782cb8dadfab26 Mon Sep 17 00:00:00 2001 From: Phoebe Pearce Date: Tue, 12 Mar 2024 13:54:53 +1100 Subject: [PATCH 1/5] license changed to LGPL. Remove Python 3.12 restriction since numba now works on 3.12 --- .github/workflows/testing.yml | 2 +- GNU_GPL_v3.txt | 674 ---------------------------------- GNU_LGPL_v3.txt | 165 +++++++++ LICENSE.txt | 14 +- README.md | 4 +- setup.py | 5 +- 6 files changed, 177 insertions(+), 687 deletions(-) delete mode 100644 GNU_GPL_v3.txt create mode 100644 GNU_LGPL_v3.txt diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index e94b9c0..a595e1c 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -16,7 +16,7 @@ jobs: fail-fast: false matrix: os: [ubuntu-latest, macos-latest, windows-latest] - python-version: ['3.9', '3.10', '3.11'] + python-version: ['3.9', '3.10', '3.11', '3.12'] # exclude: # - os: windows-latest # python-version: '3.9' diff --git a/GNU_GPL_v3.txt b/GNU_GPL_v3.txt deleted file mode 100644 index e72bfdd..0000000 --- a/GNU_GPL_v3.txt +++ /dev/null @@ -1,674 +0,0 @@ - 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 -. \ No newline at end of file diff --git a/GNU_LGPL_v3.txt b/GNU_LGPL_v3.txt new file mode 100644 index 0000000..153d416 --- /dev/null +++ b/GNU_LGPL_v3.txt @@ -0,0 +1,165 @@ + GNU LESSER 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. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser 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 +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt index 5bcc35d..d4f921e 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,20 +1,20 @@ RayFlare is a programme for flexible modelling of complicated optical structures. -Copyright (C) 2021 Phoebe Pearce +Copyright (C) 2021-2024 Phoebe Pearce 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 +it under the terms of the GNU Lesser 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. +GNU Lesser General Public License for more details. -You should have received a copy of the GNU General Public License +You should have received a copy of the GNU Lesser General Public License along with this program. If not, see . -The full license text can be found in GNU_GPL_v3.txt +The full license text can be found in GNU_LGPL_v3.txt -Contact: p.pearce@unsw.edu.au +Contact: p.pearce@unsw.edu.au or p.m.pearce@gmail.com diff --git a/README.md b/README.md index 4b0daa6..d62c486 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) +[![License: LGPL v3](https://img.shields.io/badge/License-LGPLv3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) [![codecov](https://codecov.io/gh/qpv-research-group/rayflare/branch/devel/graph/badge.svg)](https://codecov.io/gh/qpv-research-group/rayflare) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/7ff9180e5f7a460192440895d823ff15)](https://www.codacy.com/gh/qpv-research-group/rayflare?utm_source=github.com&utm_medium=referral&utm_content=qpv-research-group/rayflare&utm_campaign=Badge_Grade) [![Documentation Status](https://readthedocs.org/projects/rayflare/badge/?version=latest)](https://rayflare.readthedocs.io/en/latest/?badge=latest) @@ -17,7 +17,7 @@ layer, and absorption profiles. You can view RayFlare's documentation, including installation instructions [here](https://rayflare.readthedocs.io/en/latest/). The contributing guidelines are [here](CONTRIBUTING.md) and the Code of Conduct is [here](CODE_OF_CONDUCT.md). This package -is distributed under a [GNU GPL (version 3) license](GNU_GPL_v3.txt). If you have questions, issues, etc., please check the +is distributed under a [GNU LGPL (version 3) license](GNU_LGPL_v3.txt). If you have questions, issues, etc., please check the documentation first or open an [issue](https://github.com/qpv-research-group/rayflare/issues) using the relevant template. If you use RayFlare in your work, please cite the [JOSS paper](https://doi.org/10.21105/joss.03460): diff --git a/setup.py b/setup.py index fc2e5c2..099c0dd 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,6 @@ import sys from configparser import ConfigParser - def gen_data_files(*dirs): """Creates the list of files (not necessarily python files) that need to be installed together with the rest of stuff""" @@ -73,8 +72,8 @@ def gen_data_files(*dirs): }, author="Phoebe Pearce", author_email="phoebe.pearce15@imperial.ac.uk", - license="GNU GPLv3", - python_requires=">=3.6, <3.12", + license="GNU LGPLv3", + python_requires=">=3.6", classifiers=[ "Development Status :: 5 - Production/Stable", "Intended Audience :: Science/Research", From d8ca0520c003c220415a950a780256501baeb51f Mon Sep 17 00:00:00 2001 From: Phoebe Pearce Date: Tue, 12 Mar 2024 15:14:57 +1100 Subject: [PATCH 2/5] see if can get tests working --- .github/workflows/testing.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index a595e1c..bb10644 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -58,7 +58,7 @@ jobs: run: | git clone https://github.com/phoebe-p/S4 cd S4 - make S4_pyext + make S4_pyext --file="Makefile.mac_intel" cd .. rm -rf S4 From b69f159418fe09e9885a605d00de2eb0452ae592 Mon Sep 17 00:00:00 2001 From: Phoebe Pearce Date: Tue, 12 Mar 2024 15:22:38 +1100 Subject: [PATCH 3/5] remove S4 from macOS testing --- .github/workflows/testing.yml | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index bb10644..d46a5d1 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -34,10 +34,11 @@ jobs: sudo apt-get update sudo apt install -y python3-tk libboost-all-dev libopenblas-dev libfftw3-dev libsuitesparse-dev - - name: Install system dependencies in MacOS - if: matrix.os == 'macos-latest' - run: | - brew install fftw suite-sparse openblas lapack boost +# Do not need to do this if not installing S4 +# - name: Install system dependencies in MacOS +# if: matrix.os == 'macos-latest' +# run: | +# brew install fftw suite-sparse openblas lapack boost - name: Install python dependencies run: | @@ -53,14 +54,15 @@ jobs: cd .. rm -rf S4 - - name: Install S4 in MacOS - if: matrix.os == 'macos-latest' - run: | - git clone https://github.com/phoebe-p/S4 - cd S4 - make S4_pyext --file="Makefile.mac_intel" - cd .. - rm -rf S4 +# Not working as of March 2024. Cannot find cholmod.h header file. Reason unclear. +# - name: Install S4 in MacOS +# if: matrix.os == 'macos-latest' +# run: | +# git clone https://github.com/phoebe-p/S4 +# cd S4 +# make S4_pyext --file="Makefile.mac_intel" +# cd .. +# rm -rf S4 - name: Install on Linux and MacOS if: matrix.os != 'windows-latest' From e713b97646ce668b81a85bd005497251914e8e01 Mon Sep 17 00:00:00 2001 From: Phoebe Pearce Date: Tue, 12 Mar 2024 16:33:06 +1100 Subject: [PATCH 4/5] fix testing to skip RCWA tests on any platform if S4 is not installed --- tests/conftest.py | 12 ++++++++++++ tests/test_analytic.py | 5 ++--- tests/test_compare_methods.py | 18 +++++++++--------- tests/test_ideal_cases.py | 1 - tests/test_matrix_formalism.py | 1 - tests/test_rigorous_coupled_wave.py | 17 ++++++++--------- tests/test_utilities.py | 5 ++--- 7 files changed, 33 insertions(+), 26 deletions(-) create mode 100644 tests/conftest.py diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..73b04ae --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,12 @@ +def skip_s4_test(): + """ + Utility function for skipping the test if S4 is not installed, + + Returns: True if S4 not installed False otherwise + """ + + try: + import S4 + return False + except ModuleNotFoundError: + return True \ No newline at end of file diff --git a/tests/test_analytic.py b/tests/test_analytic.py index aedb543..f9b64a1 100644 --- a/tests/test_analytic.py +++ b/tests/test_analytic.py @@ -1,9 +1,8 @@ import numpy as np from pytest import approx, mark -import sys +from .conftest import skip_s4_test - -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") def test_get_order_directions(): from rayflare.analytic.diffraction import get_order_directions from solcore import material diff --git a/tests/test_compare_methods.py b/tests/test_compare_methods.py index ed967a6..561af60 100644 --- a/tests/test_compare_methods.py +++ b/tests/test_compare_methods.py @@ -2,9 +2,9 @@ import numpy as np import sys import itertools +from .conftest import skip_s4_test - -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") @mark.parametrize("RCWA_method", ["S4", "Inkstone"]) def test_tmm_rcwa_structure_comparison(RCWA_method): from solcore import si, material @@ -65,7 +65,7 @@ def test_tmm_rcwa_structure_comparison(RCWA_method): assert np.sum(rcwa_result["A_per_layer"], 1) + rcwa_result["R"] + rcwa_result["T"] == approx(1) -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") @mark.parametrize("RCWA_method", ["S4", "Inkstone"]) def test_planar_structure(RCWA_method): # solcore imports @@ -216,7 +216,7 @@ def test_planar_structure(RCWA_method): ).data == approx(1) -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") @mark.parametrize("RCWA_method", ["S4", "Inkstone"]) def test_planar_structure_45deg(RCWA_method): # solcore imports @@ -368,7 +368,7 @@ def test_planar_structure_45deg(RCWA_method): ).data == approx(1) -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") @mark.parametrize("RCWA_method", ["S4", "Inkstone"]) def test_tmm_rcwa_pol_angle(RCWA_method): # solcore imports @@ -700,7 +700,7 @@ def test_absorption_profile_coh_angles(): assert rt_profile_u == approx(tmm_profile_u, rel=0.4) -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") @mark.parametrize("RCWA_method", ["S4", "Inkstone"]) def test_rcwa_tmm_profiles_coh(RCWA_method): from rayflare.options import default_options @@ -775,7 +775,7 @@ def test_rcwa_tmm_profiles_coh(RCWA_method): assert rcwa_profile_u == approx(tmm_profile_u, rel=0.025) -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") @mark.parametrize("RCWA_method", ["S4", "Inkstone"]) def test_rcwa_tmm_matrix_check_sums(RCWA_method): from solcore.structure import Layer @@ -965,7 +965,7 @@ def test_rcwa_tmm_matrix_check_sums(RCWA_method): assert results_per_layer_back_RCWA[c_i] == approx(results_per_layer_back_TMM_ref[c_i], rel=0.05) -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") @mark.parametrize("RCWA_method", ["S4", "Inkstone"]) def test_rcwa_tmm_matrix_profiles(RCWA_method): from solcore.structure import Layer @@ -1147,7 +1147,7 @@ def test_rcwa_tmm_matrix_profiles(RCWA_method): assert prof_plot_RCWA_back.data[c_i] == approx(back_profile_TMM[c_i], rel=0.15) -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") @mark.parametrize("RCWA_method", ["S4", "Inkstone"]) def test_profile_integration(RCWA_method): from rayflare.utilities import get_savepath diff --git a/tests/test_ideal_cases.py b/tests/test_ideal_cases.py index dbb93ea..c553735 100644 --- a/tests/test_ideal_cases.py +++ b/tests/test_ideal_cases.py @@ -1,7 +1,6 @@ import numpy as np from pytest import approx - def test_lambertian_scattering(): from rayflare.matrix_formalism.ideal_cases import lambertian_matrix from rayflare.angles import make_angle_vector diff --git a/tests/test_matrix_formalism.py b/tests/test_matrix_formalism.py index 8580e08..f4ff1c4 100644 --- a/tests/test_matrix_formalism.py +++ b/tests/test_matrix_formalism.py @@ -1,7 +1,6 @@ from pytest import approx import numpy as np - def test_bulk_profile(): from solcore import material diff --git a/tests/test_rigorous_coupled_wave.py b/tests/test_rigorous_coupled_wave.py index 82fe27c..edb9758 100644 --- a/tests/test_rigorous_coupled_wave.py +++ b/tests/test_rigorous_coupled_wave.py @@ -1,9 +1,8 @@ from pytest import approx, mark import numpy as np -import sys +from .conftest import skip_s4_test - -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") @mark.parametrize("RCWA_method", ["S4", "Inkstone"]) def test_RAT(RCWA_method): from solcore import si, material @@ -122,7 +121,7 @@ def test_RAT(RCWA_method): ) -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") @mark.parametrize("RCWA_method", ["S4", "Inkstone"]) def test_RAT_angle_pol(RCWA_method): from solcore import si, material @@ -199,7 +198,7 @@ def test_RAT_angle_pol(RCWA_method): assert RAT["R"] + RAT["T"] + np.sum(RAT["A_per_layer"], 1) == approx(1) -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") @mark.parametrize("RCWA_method", ["S4", "Inkstone"]) def test_RAT_angle_pol_ninc(RCWA_method): from solcore import si, material @@ -276,7 +275,7 @@ def test_RAT_angle_pol_ninc(RCWA_method): assert RAT["R"] + RAT["T"] + np.sum(RAT["A_per_layer"], 1) == approx(1) -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") @mark.parametrize("RCWA_method", ["S4", "Inkstone"]) def test_shapes(RCWA_method): from solcore import material @@ -362,7 +361,7 @@ def test_shapes(RCWA_method): assert np.all(A_back[i1] > A_back[-1]) -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") def test_reciprocal_lattice(): from rayflare.rigorous_coupled_wave_analysis.rcwa import get_reciprocal_lattice @@ -374,7 +373,7 @@ def test_reciprocal_lattice(): assert a[1] == approx((0, 1 / 200)) -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") def test_plotting_funcs(): from solcore import si, material from solcore.structure import Layer @@ -506,7 +505,7 @@ def test_plotting_funcs(): assert H.shape == (len(xs), len(ys), 3) -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") @mark.parametrize("RCWA_method", ["S4", "Inkstone"]) def test_matrix_generation(RCWA_method): from rayflare.rigorous_coupled_wave_analysis import RCWA diff --git a/tests/test_utilities.py b/tests/test_utilities.py index 8033527..ac1953c 100644 --- a/tests/test_utilities.py +++ b/tests/test_utilities.py @@ -1,9 +1,8 @@ from pytest import approx, mark import numpy as np -import sys +from .conftest import skip_s4_test - -@mark.skipif(sys.platform == "win32", reason="S4 (RCWA) only installed for tests under Linux and macOS") +@mark.skipif(skip_s4_test(), reason="Only works if S4 installed") def test_tmm_rcwa_profile(): from rayflare.utilities import make_absorption_function from rayflare.transfer_matrix_method import tmm_structure From 271fa18585cd2a80515054e51459e51a4281f6c1 Mon Sep 17 00:00:00 2001 From: Phoebe Pearce Date: Tue, 12 Mar 2024 17:20:58 +1100 Subject: [PATCH 5/5] Update license notice in each file --- rayflare/analytic/diffraction.py | 4 ++-- rayflare/angles.py | 4 ++-- rayflare/matrix_formalism/ideal_cases.py | 4 ++-- rayflare/matrix_formalism/multiply_matrices.py | 4 ++-- rayflare/matrix_formalism/process_structure.py | 4 ++-- rayflare/options.py | 4 ++-- rayflare/ray_tracing/rt.py | 4 ++-- rayflare/rigorous_coupled_wave_analysis/rcwa.py | 4 ++-- rayflare/structure.py | 4 ++-- rayflare/textures/define_textures.py | 4 ++-- rayflare/textures/standard_rt_textures.py | 4 ++-- rayflare/transfer_matrix_method/lookup_table.py | 7 +++++++ rayflare/transfer_matrix_method/tmm.py | 7 +++++++ rayflare/utilities.py | 4 ++-- 14 files changed, 38 insertions(+), 24 deletions(-) diff --git a/rayflare/analytic/diffraction.py b/rayflare/analytic/diffraction.py index bfe52ee..6b7f767 100644 --- a/rayflare/analytic/diffraction.py +++ b/rayflare/analytic/diffraction.py @@ -1,6 +1,6 @@ -# Copyright (C) 2021 Phoebe Pearce +# Copyright (C) 2021-2024 Phoebe Pearce # -# This file is part of RayFlare and is released under the GNU General Public License (GPL), version 3. +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. # Please see the LICENSE.txt file included as part of this package. # # Contact: p.pearce@unsw.edu.au diff --git a/rayflare/angles.py b/rayflare/angles.py index 90cd28a..b69d35d 100644 --- a/rayflare/angles.py +++ b/rayflare/angles.py @@ -1,6 +1,6 @@ -# Copyright (C) 2021 Phoebe Pearce +# Copyright (C) 2021-2024 Phoebe Pearce # -# This file is part of RayFlare and is released under the GNU General Public License (GPL), version 3. +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. # Please see the LICENSE.txt file included as part of this package. # # Contact: p.pearce@unsw.edu.au diff --git a/rayflare/matrix_formalism/ideal_cases.py b/rayflare/matrix_formalism/ideal_cases.py index bb15dfe..ae9f963 100644 --- a/rayflare/matrix_formalism/ideal_cases.py +++ b/rayflare/matrix_formalism/ideal_cases.py @@ -1,6 +1,6 @@ -# Copyright (C) 2021 Phoebe Pearce +# Copyright (C) 2021-2024 Phoebe Pearce # -# This file is part of RayFlare and is released under the GNU General Public License (GPL), version 3. +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. # Please see the LICENSE.txt file included as part of this package. # # Contact: p.pearce@unsw.edu.au diff --git a/rayflare/matrix_formalism/multiply_matrices.py b/rayflare/matrix_formalism/multiply_matrices.py index 97dcf30..8390f2b 100644 --- a/rayflare/matrix_formalism/multiply_matrices.py +++ b/rayflare/matrix_formalism/multiply_matrices.py @@ -1,6 +1,6 @@ -# Copyright (C) 2021 Phoebe Pearce +# Copyright (C) 2021-2024 Phoebe Pearce # -# This file is part of RayFlare and is released under the GNU General Public License (GPL), version 3. +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. # Please see the LICENSE.txt file included as part of this package. # # Contact: p.pearce@unsw.edu.au diff --git a/rayflare/matrix_formalism/process_structure.py b/rayflare/matrix_formalism/process_structure.py index 8057aad..84ab1da 100644 --- a/rayflare/matrix_formalism/process_structure.py +++ b/rayflare/matrix_formalism/process_structure.py @@ -1,6 +1,6 @@ -# Copyright (C) 2021 Phoebe Pearce +# Copyright (C) 2021-2024 Phoebe Pearce # -# This file is part of RayFlare and is released under the GNU General Public License (GPL), version 3. +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. # Please see the LICENSE.txt file included as part of this package. # # Contact: p.pearce@unsw.edu.au diff --git a/rayflare/options.py b/rayflare/options.py index 046f8d7..43147e7 100644 --- a/rayflare/options.py +++ b/rayflare/options.py @@ -1,6 +1,6 @@ -# Copyright (C) 2021 Phoebe Pearce +# Copyright (C) 2021-2024 Phoebe Pearce # -# This file is part of RayFlare and is released under the GNU General Public License (GPL), version 3. +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. # Please see the LICENSE.txt file included as part of this package. # # Contact: p.pearce@unsw.edu.au diff --git a/rayflare/ray_tracing/rt.py b/rayflare/ray_tracing/rt.py index a6a26c5..b78cbd1 100644 --- a/rayflare/ray_tracing/rt.py +++ b/rayflare/ray_tracing/rt.py @@ -1,6 +1,6 @@ -# Copyright (C) 2021 Phoebe Pearce +# Copyright (C) 2021-2024 Phoebe Pearce # -# This file is part of RayFlare and is released under the GNU General Public License (GPL), version 3. +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. # Please see the LICENSE.txt file included as part of this package. # # Contact: p.pearce@unsw.edu.au diff --git a/rayflare/rigorous_coupled_wave_analysis/rcwa.py b/rayflare/rigorous_coupled_wave_analysis/rcwa.py index c72ac57..1e6b101 100644 --- a/rayflare/rigorous_coupled_wave_analysis/rcwa.py +++ b/rayflare/rigorous_coupled_wave_analysis/rcwa.py @@ -1,6 +1,6 @@ -# Copyright (C) 2021 Phoebe Pearce +# Copyright (C) 2021-2024 Phoebe Pearce # -# This file is part of RayFlare and is released under the GNU General Public License (GPL), version 3. +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. # Please see the LICENSE.txt file included as part of this package. # # Contact: p.pearce@unsw.edu.au diff --git a/rayflare/structure.py b/rayflare/structure.py index a630019..6c76bbf 100644 --- a/rayflare/structure.py +++ b/rayflare/structure.py @@ -1,6 +1,6 @@ -# Copyright (C) 2021 Phoebe Pearce +# Copyright (C) 2021-2024 Phoebe Pearce # -# This file is part of RayFlare and is released under the GNU General Public License (GPL), version 3. +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. # Please see the LICENSE.txt file included as part of this package. # # Contact: p.pearce@unsw.edu.au diff --git a/rayflare/textures/define_textures.py b/rayflare/textures/define_textures.py index e5647f7..210473a 100644 --- a/rayflare/textures/define_textures.py +++ b/rayflare/textures/define_textures.py @@ -1,6 +1,6 @@ -# Copyright (C) 2021 Phoebe Pearce +# Copyright (C) 2021-2024 Phoebe Pearce # -# This file is part of RayFlare and is released under the GNU General Public License (GPL), version 3. +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. # Please see the LICENSE.txt file included as part of this package. # # Contact: p.pearce@unsw.edu.au diff --git a/rayflare/textures/standard_rt_textures.py b/rayflare/textures/standard_rt_textures.py index c6afe63..0dddb11 100644 --- a/rayflare/textures/standard_rt_textures.py +++ b/rayflare/textures/standard_rt_textures.py @@ -1,6 +1,6 @@ -# Copyright (C) 2021 Phoebe Pearce +# Copyright (C) 2021-2024 Phoebe Pearce # -# This file is part of RayFlare and is released under the GNU General Public License (GPL), version 3. +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. # Please see the LICENSE.txt file included as part of this package. # # Contact: p.pearce@unsw.edu.au diff --git a/rayflare/transfer_matrix_method/lookup_table.py b/rayflare/transfer_matrix_method/lookup_table.py index ac8a041..bd629b0 100644 --- a/rayflare/transfer_matrix_method/lookup_table.py +++ b/rayflare/transfer_matrix_method/lookup_table.py @@ -1,3 +1,10 @@ +# Copyright (C) 2021-2024 Phoebe Pearce +# +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. +# Please see the LICENSE.txt file included as part of this package. +# +# Contact: p.pearce@unsw.edu.au + import xarray as xr import numpy as np from rayflare.transfer_matrix_method.tmm import tmm_structure diff --git a/rayflare/transfer_matrix_method/tmm.py b/rayflare/transfer_matrix_method/tmm.py index 4e2e99b..c0e8e23 100644 --- a/rayflare/transfer_matrix_method/tmm.py +++ b/rayflare/transfer_matrix_method/tmm.py @@ -1,3 +1,10 @@ +# Copyright (C) 2021-2024 Phoebe Pearce +# +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. +# Please see the LICENSE.txt file included as part of this package. +# +# Contact: p.pearce@unsw.edu.au + import numpy as np import xarray as xr from sparse import COO, save_npz, stack diff --git a/rayflare/utilities.py b/rayflare/utilities.py index dab63bf..c7c2733 100644 --- a/rayflare/utilities.py +++ b/rayflare/utilities.py @@ -1,6 +1,6 @@ -# Copyright (C) 2021 Phoebe Pearce +# Copyright (C) 2021-2024 Phoebe Pearce # -# This file is part of RayFlare and is released under the GNU General Public License (GPL), version 3. +# This file is part of RayFlare and is released under the GNU Lesser General Public License (LGPL), version 3. # Please see the LICENSE.txt file included as part of this package. # # Contact: p.pearce@unsw.edu.au