diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f3d3be5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +__pycache__ +.ipynb_checkpoints +.vim +.old +testing +bspc_rule.sh +readings.txt +setup.py diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/cpdctrl/__init__.py b/cpdctrl/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/cpdctrl/backends/__init__.py b/cpdctrl/backends/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/cpdctrl/backends/keithley/__init__.py b/cpdctrl/backends/keithley/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/cpdctrl/backends/keithley/keithley.py b/cpdctrl/backends/keithley/keithley.py new file mode 100644 index 0000000..4003b93 --- /dev/null +++ b/cpdctrl/backends/keithley/keithley.py @@ -0,0 +1,124 @@ +import pyvisa +import numpy as np +# import pkg_resources + + +class Keithley2007: + + """ + Utility + """ + scripts = {} + + def __init__(self, beep_success=True, visa_backend="", check_front_switch=True): + rm = pyvisa.ResourceManager(visa_backend) + resources = rm.list_resources() + if len(resources) < 1: + raise Exception("No resources found.") + elif len(resources) == 1: + print(f"Opening the only resource found: {resources[0]}") + self. = rm.open_resource(resources[0]) + if beep_success: keithley.write("beeper.beep(0.5, 1000)") + return keithley + elif len(resources) > 1: + print(f"Resources:") + for i, r in enumerate(resources): + print(f"{i:02}: {r}") + instr = int(input("Select an instrument: ")) + self.instr = rm.open_resource(resources[instr]) + if beep_success: self.beep() + if check_front_switch: + self._check_front_input_selected() + + def _check_front_input_selected(self): + switch = self.instr.query("SYSTem:FRSwitch?").strip("\n") + if switch != "1": + raise Exception("The Keithley's INPUT switch must select the [F]ront inputs") + return switch + + + def run_script(self, script_path, verbose=False): + """ + Run a script from the host on the instrument + @param script_path : full path to the script + """ + with open(script_path, "r") as file: + script = file.read() + if verbose: print(f"Running script: {script_path}") + self.instr.write(script) + + def beep(self, length=0.5, pitch=1000): + """The Keithley2700 cant beep on command :(""" + pass + + def __del__(self): + """Properly close the instrument connection""" + self.instr.close() + + + + def reset(self, verbose=False): + """ + Reset smua and its buffers + @param instr : pyvisa instrument + """ + self.run_script(self.instr, scripts["smua_reset"], verbose=verbose) + run_lua(self.instr, scripts["buffer_reset"], verbose=verbose) + + + + def get_buffer_size(instr, buffer_nr=1): + n = instr.query(f"print({get_buffer_name(buffer_nr)}.n)").strip("\n") + return int(float(n)) + + + def collect_buffer(instr, buffer_nr=1, verbose=False): + """ + Get the buffer as 2D - np.array + @param instr : pyvisa instrument + @param buffer_nr : 1 or 2, for smua.nvbuffer1 or 2 + @returns 2D numpy array: + i - ith reading: + 0: timestamps + 1: readings + """ + buffername = get_buffer_name(buffer_nr) + # instr.write("format.data = format.DREAL\nformat.byteorder = format.LITTLEENDIAN") + # buffer = instr.query_binary_values(f"printbuffer(1, {buffername}.n, {buffername})", datatype='d', container=np.array) + instr.write("format.data = format.ASCII\nformat.asciiprecision = 7") + timestamps = instr.query_ascii_values(f"printbuffer(1, {buffername}.n, {buffername}.timestamps)", container=np.array) + readings = instr.query_ascii_values(f"printbuffer(1, {buffername}.n, {buffername}.readings)", container=np.array) + if verbose: + print(f"readings from {buffername}: {readings}, \ntimestamps: {timestamps}") + buffer = np.vstack((timestamps, readings)).T + return buffer + + + + def collect_buffer_range(instr, range_=(1, -1), buffer_nr=1, verbose=False): + """ + Get the buffer as 2D - np.array + @param instr : pyvisa instrument + @param buffer_nr : 1 or 2, for smua.nvbuffer1 or 2 + @returns 2D numpy array: + i - ith reading: + 0: timestamps + 1: readings + """ + buffername = get_buffer_name(buffer_nr) + # instr.write("format.data = format.DREAL\nformat.byteorder = format.LITTLEENDIAN") + # buffer = instr.query_binary_values(f"printbuffer(1, {buffername}.n, {buffername})", datatype='d', container=np.array) + if range_[1] == -1: + range_ = (range_[0], f"{buffername}.n") + instr.write("format.data = format.ASCII\nformat.asciiprecision = 7") + timestamps = instr.query_ascii_values(f"printbuffer({range_[0]}, {range_[1]}, {buffername}.timestamps)", container=np.array) + readings = instr.query_ascii_values(f"printbuffer({range_[0]}, {range_[1]}, {buffername}.readings)", container=np.array) + if verbose: + print(f"readings from {buffername}: {readings}, \ntimestamps: {timestamps}") + buffer = np.vstack((timestamps, readings)).T + return buffer + + + + + diff --git a/cpdctrl/backends/keithley/measure.py b/cpdctrl/backends/keithley/measure.py new file mode 100644 index 0000000..f688c8e --- /dev/null +++ b/cpdctrl/backends/keithley/measure.py @@ -0,0 +1,93 @@ +from time import sleep +import numpy as np +from matplotlib import pyplot as plt +import pyvisa + +from cpdctrl.backends.keithley.keithley import reset +from cpdctrl.utility import testing as _testing + +def measure_count(instr, count=100, interval=0.05, update_func=None, update_interval=0.5, beep_done=True, verbose=True): + """ + Take measurements with inbetween + + @details + Uses the devices overlappedY function to make the measurements asynchronosly + The update_func is optional and only used when I == True and V == True + The update_func does not necessarily get all the values that are measured. To obtain the whole measurement, get them from the device buffers (smua.nvbufferX) + @param instr: pyvisa instrument + @param update_func: Callable that processes the measurements: (index, ival, vval) -> None + @param update_interval: interval at which the update_func is called + """ + f_meas = "smua.measure.overlappediv(smua.nvbuffer1, smua.nvbuffer2)" + # if V and I: + # elif V: + # f_meas = "smua.measure.overlappedv(smua.nvbuffer1)" + # elif I: + # f_meas = "smua.measure.overlappedi(smua.nvbuffer1)" + # else: + # print("I and/or V needs to be set to True") + # return + + i = 0 + reset(instr, verbose=verbose) + instr.write(f"smua.measure.count = {count}") + instr.write(f"smua.measure.interval = {interval}") + + # start measurement + instr.write(f"smua.source.output = smua.OUTPUT_ON") + instr.write(f_meas) + + sleep(update_interval) + # for live viewing + query = """if smua.nvbufferX.n > 0 then print(smua.nvbufferX.readings[smua.nvbufferX.n]) else print(0) end""" + + # will return 2.0 while measruing + while float(instr.query("print(status.operation.measuring.condition)").strip("\n ")) != 0: + if update_func: + try: + ival = float(instr.query(query.replace("X", "1")).strip("\n")) + vval = float(instr.query(query.replace("X", "2")).strip("\n")) + update_func(i, ival, vval) + except ValueError as e: + if i != 0: + pass + else: + print(f"measure_count: ValueError: {e}") + sleep(update_interval) + i += 1 + + instr.write(f"smua.source.output = smua.OUTPUT_OFF") + + if beep_done: + instr.write("beeper.beep(0.3, 1000)") + + +def measure(instr, interval, update_func=None, max_measurements=None): + """ + @details: + - Resets the buffers + - Until KeyboardInterrupt: + - Take measurement + - Call update_func + - Wait interval + Uses python's time.sleep() for waiting the interval, which is not very precise. Use measure_count for better precision + You can take the data from the buffer afterwards, using save_csv + @param instr: pyvisa instrument + @param update_func: Callable that processes the measurements: (index, ival, vval) -> None + @param max_measurements : maximum number of measurements. None means infinite + """ + reset(instr, verbose=True) + instr.write("smua.source.output = smua.OUTPUT_ON") + instr.write("format.data = format.ASCII\nformat.asciiprecision = 12") + try: + i = 0 + while max_measurements is None or i < max_measurements: + ival, vval = tuple(float(v) for v in instr.query("print(smua.measure.iv(smua.nvbuffer1, smua.nvbuffer2))").strip('\n').split('\t')) + if update_func: + update_func(i, ival, vval) + sleep(interval) + i += 1 + except KeyboardInterrupt: + pass + instr.write("smua.source.output = smua.OUTPUT_OFF") + print("Measurement stopped" + " "*50) diff --git a/cpdctrl/cpdctrl-interactive.py b/cpdctrl/cpdctrl-interactive.py new file mode 100644 index 0000000..c5a4c53 --- /dev/null +++ b/cpdctrl/cpdctrl-interactive.py @@ -0,0 +1,380 @@ +""" +run this before using this library: +ipython -i cpdctrl_interactive.py + +always records iv-t curves + i-data -> smua.nvbuffer1 + v-data -> smua.nvbuffer2 +""" + +import numpy as np +import matplotlib.pyplot as plt +import pandas as pd + +from datetime import datetime as dtime +from sys import exit +from time import sleep +from os import path, makedirs +import pickle as pkl +import json +import atexit + +import argparse + + +if __name__ == "__main__": + import sys + if __package__ is None: + # make relative imports work as described here: https://peps.python.org/pep-0366/#proposed-change + __package__ = "cpdctrl" + from os import path + filepath = path.realpath(path.abspath(__file__)) + sys.path.insert(0, path.dirname(path.dirname(filepath))) + parser = argparse.ArgumentParser( + prog="m-teng", + description="measure triboelectric nanogenerator output using a Keithley SMU or an Arduino", + ) + backend_group = parser.add_mutually_exclusive_group(required=True) + backend_group.add_argument("-k", "--keithley", action="store_true") + backend_group.add_argument("-t", "--testing", action='store_true') + parser.add_argument("-c", "--config", action="store", help="alternate path to config file") + args = vars(parser.parse_args()) + + i = 1 + while i < len(sys.argv): + if args["keithley"]: + import cpdctrl.backends.keithley.keithley as _backend + import cpdctrl.backends.keithley.measure as _measure + elif args["arduino"]: + import cpdctrl.backends.arduino.arduino as _backend + import cpdctrl.backends.arduino.measure as _measure + elif args["testing"]: + import cpdctrl.backends.testing.testing as _backend + import cpdctrl.backends.testing.measure as _measure + elif sys.argv[i] in ["-c", "--config"]: + if i+1 < len(sys.argv): + config_path = sys.argv[i+1] + else: + print("-c requires an extra argument: path of config file") + i += 1 + i += 1 + + +from cpdctrl.utility import data as _data +from cpdctrl.utility.data import load_dataframe +from cpdctrl.utility import file_io +from cpdctrl.update_funcs import _Monitor, _update_print + +config_path = path.expanduser("~/.config/m-teng.json") + +_runtime_vars = { + "last-measurement": "" +} + +settings = { + "datadir": path.expanduser("~/data"), + "name": "measurement", + "interval": 0.02, + "beep": True, +} + +test = False + +# global variable for the instrument/client returned by pyvisa/bleak +dev = None + + +def monitor_count(count=5000, interval=None, max_points_shown=160): + """ + Take measurements in and monitor live with matplotlib. + + @details: + - Resets the buffers + - Opens a matplotlib window and takes measurements depending on settings["interval"] + Uses the device internal overlappedY measurement method, which allows for greater precision + You can take the data from the buffer afterwards, using save_csv + @param count: count + @param interval: interval, defaults to settings["interval"] + @param max_points_shown: how many points should be shown at once. None means infinite + """ + if not interval: interval = settings["interval"] + plt_monitor = _Monitor(max_points_shown, use_print=True) + update_func = plt_monitor.update + + print(f"Starting measurement with:\n\tinterval = {interval}s\nSave the data using 'save_csv()' afterwards.") + try: + _measure.measure_count(dev, count=count, interval=interval, beep_done=False, verbose=False, update_func=update_func, update_interval=0.05) + except KeyboardInterrupt: + if args["keithley"]: + dev.write(f"smua.source.output = smua.OUTPUT_OFF") + print("Monitoring cancelled, measurement might still continue" + " "*50) + else: + print("Measurement finished" + " "*50) + +def measure_count(count=5000, interval=None): + """ + Take measurements in + + @details: + - Resets the buffers + - Takes measurements depending on settings["interval"] + Uses the device internal overlappedY measurement method, which allows for greater precision + You can take the data from the buffer afterwards, using save_csv + @param count: count + @param interval: interval, defaults to settings["interval"] + """ + if not interval: interval = settings["interval"] + update_func = _update_print + + print(f"Starting measurement with:\n\tinterval = {interval}s\nSave the data using 'save_csv()' afterwards.") + try: + _measure.measure_count(dev, count=count, interval=interval, beep_done=False, verbose=False, update_func=update_func, update_interval=0.05) + except KeyboardInterrupt: + if args["keithley"]: + dev.write(f"smua.source.output = smua.OUTPUT_OFF") + print("Monitoring cancelled, measurement might still continue" + " "*50) + else: + print("Measurement finished" + " "*50) + + + + +def monitor(interval=None, max_measurements=None, max_points_shown=160): + """ + Monitor the voltage with matplotlib. + + @details: + - Resets the buffers + - Opens a matplotlib window and takes measurements depending on settings["interval"] + - Waits for the user to press a key + Uses python's time.sleep() for waiting the interval, which is not very precise. Use measure_count for better precision. + You can take the data from the buffer afterwards, using save_csv. + @param max_points_shown : how many points should be shown at once. None means infinite + @param max_measurements : maximum number of measurements. None means infinite + """ + global _runtime_vars + _runtime_vars["last_measurement"] = dtime.now().isoformat() + if not interval: interval = settings["interval"] + print(f"Starting measurement with:\n\tinterval = {interval}s\nUse to stop. Save the data using 'save_csv()' afterwards.") + plt_monitor = _Monitor(use_print=True, max_points_shown=max_points_shown) + update_func = plt_monitor.update + _measure.measure(dev, interval=interval, max_measurements=max_measurements, update_func=update_func) + + +def measure(interval=None, max_measurements=None): + """ + Measure voltages + + @details: + - Resets the buffers + - Measure voltages + - Waits for the user to press a key + Uses python's time.sleep() for waiting the interval, which is not very precise. Use measure_count for better precision. + You can take the data from the buffer afterwards, using save_csv. + @param max_measurements : maximum number of measurements. None means infinite + """ + global _runtime_vars + if not interval: interval = settings["interval"] + _runtime_vars["last_measurement"] = dtime.now().isoformat() + print(f"Starting measurement with:\n\tinterval = {interval}s\nUse to stop. Save the data using 'save_csv()' afterwards.") + update_func = _update_print + _measure.measure(dev, interval=interval, max_measurements=max_measurements, update_func=update_func) + + +def repeat(measure_func: callable, count: int, repeat_delay=0): + """ + Measure and save to csv multiple times + + @details + Repeat count times: + - call measure_func + - call save_csv + - sleep for repeat_delay + + @param measure_func: The measurement function to use. Use a lambda to bind your parameters! + @param count: Repeat count times + + Example: Repeat 10 times: + repeat(lambda : monitor_count(count=6000, interval=0.02, max_points_shown=200), 10) + """ + try: + for _ in range(count): + measure_func() + save_csv() + sleep(repeat_delay) + except KeyboardInterrupt: + pass + if settings["beep"]: _backend.beep(dev) + + +def get_dataframe(): + """ + Get a pandas dataframe from the data in smua.nvbuffer1 and smua.nvbuffer2 + """ + global k, settings, _runtime_vars + ibuffer = _backend.collect_buffer(dev, 1) + vbuffer = _backend.collect_buffer(dev, 2) + df = _data.buffers2dataframe(ibuffer, vbuffer) + df.basename = file_io.get_next_filename(settings["name"], settings["datadir"]) + df.name = f"{df.basename} @ {_runtime_vars['last-measurement']}" + return df + + +def save_csv(): + """ + Saves the contents of nvbuffer1 as .csv + The settings 'datadir' and 'name' are used for determining the filepath: + 'datadir/nameXXX.csv', where XXX is the number of files that exist in datadir with the same name. + """ + df = get_dataframe() + filename = settings["datadir"] + "/" + df.basename + ".csv" + df.to_csv(filename, index=False, header=True) + print(f"Saved as '{filename}'") + + +def save_pickle(): + """ + Saves the contents of nvbuffer1 as .pkl + The settings 'datadir' and 'name' are used for determining the filepath: + 'datadir/nameXXX.pkl', where XXX is the number of files that exist in datadir with the same name. + """ + df = get_dataframe() + filename = settings["datadir"] + "/" + df.basename + ".pkl" + df.to_pickle(filename) + print(f"Saved as '{filename}'") + + +def run_script(script_path): + """ + Run a lua script on the Keithley device + @param script_path : relative or absolute path to the .lua script + """ + global k, settings + if test: + print("run_script: Test mode enabled, ignoring call to run_script") + else: + _backend.run_lua(dev, script_path=script_path) + + +def set(setting, value): + global settings, config_path + if setting in settings: + if type(value) != type(settings[setting]): + print(f"set: setting '{setting}' currently holds a value of type '{type(settings[setting])}'") + return + settings[setting] = value + +def name(s:str): + global settings + settings["name"] = s + +def save_settings(): + with open(config_path, "w") as file: + json.dump(settings, file, indent=4) + +def load_settings(): + global settings, config_path + with open(config_path, "r") as file: + settings = json.load(file) + settings["datadir"] = path.expanduser(settings["datadir"]) # replace ~ + +def help(topic=None): + if topic == None: + print(""" +Functions: + measure [kat] - take measurements + monitor [kat] - take measurements with live monitoring in a matplotlib window + measure_count [kat] - take a fixed number of measurements + monitor_count [kat] - take a fixed number of measurements with live monitoring in a matplotlib window + repeat [kat] - measure and save to csv multiple times + get_dataframe [kat] - return device internal buffer as pandas dataframe + save_csv [kat] - save the last measurement as csv file + save_pickle [kat] - save the last measurement as pickled pandas dataframe + load_dataframe [kat] - load a pandas dataframe from csv or pickle + run_script [k ] - run a lua script on the Keithely device +Run 'help(function)' to see more information on a function + +Available topics: + imports + device + settings +Run 'help("topic")' to see more information on a topic""") + + elif topic in [settings, "settings"]: + print("""Settings: + name: str - name of the measurement, determines filename of 'save_csv' + datadir: str - output directory for the csv files + interval: int - interval (inverse frequency) of the measurements, in seconds + beep: bool - wether the device should beep or not + +Functions: + name("") - short for set("name", "") + set("setting", value) - set a setting to a value + save_settings() - store the settings as "m-teng.json" in the working directory + load_settings() - load settings from a file + The global variable 'config_path' determines the path used by save/load_settings. Use -c '' to set another path. + The serach path is: + /m-teng.json + $XDG_CONFIG_HOME/m-teng.json + ~/.config/m-teng.json + """) + elif topic == "imports": + print("""Imports: + numpy as np + pandas as pd + matplotlib.pyplot as plt + os.path """) + elif topic == "device": + print("""Device: + keithley backend: + The opened pyvisa resource (deveithley device) is the global variable 'dev'. + You can interact using pyvisa functions, such as + k.write("command"), k.query("command") etc. to interact with the device. + arduino backend: + The Arduino will be avaiable as BleakClient using the global variable 'dev'. """) + else: + print(topic.__doc__) + + +def init(): + global dev, settings, config_path + print(r""" ______________________ _______ ________ + _____ \__ ___/\_ _____/ \ \ / _____/ + / \ ______| | | __)_ / | \ / \ ___ +| Y Y \/_____/| | | \/ | \\ \_\ \ +|__|_| / |____| /_______ /\____|__ / \______ / + \/ \/ \/ \/ 1.2 +Interactive Shell for TENG measurements with Keithley 2600B +--- +Enter 'help()' for a list of commands""") + from os import environ + if path.isfile("m-teng.json"): + config_path = "m-teng.json" + elif 'XDG_CONFIG_HOME' in environ.keys(): + # and path.isfile(environ["XDG_CONFIG_HOME"] + "/m-teng.json"): + config_path = environ["XDG_CONFIG_HOME"] + "/m-teng.json" + else: + config_path = path.expanduser("~/.config/m-teng.json") + if args["config"]: + config_path = args["config"] + + + if not path.isdir(path.dirname(config_path)): + makedirs(path.dirname(config_path)) + + if path.isfile(config_path): + load_settings() + + if not path.isdir(settings["datadir"]): + makedirs(settings["datadir"]) + + try: + dev = _backend.init(beep_success=settings["beep"]) + except Exception as e: + print(e) + exit(1) + atexit.register(_backend.exit, dev) + + +if __name__ == "__main__": + init() diff --git a/cpdctrl/keithley_scripts/reset.scpi b/cpdctrl/keithley_scripts/reset.scpi new file mode 100644 index 0000000..5ccb722 --- /dev/null +++ b/cpdctrl/keithley_scripts/reset.scpi @@ -0,0 +1,5 @@ +VOLT:DC:RANGe:AUTO ON +' DC Voltage measurement +SENSe:FUNC 'VOLT:DC' +' Set voltage divider if required +' SENSE:VOLT:DC:IDIVider OFF diff --git a/cpdctrl/keithley_scripts/scan.scpi b/cpdctrl/keithley_scripts/scan.scpi new file mode 100644 index 0000000..ea997a1 --- /dev/null +++ b/cpdctrl/keithley_scripts/scan.scpi @@ -0,0 +1,6 @@ +' Disable continuous initiation +INIT:CONT OFF +' two readings per second +TRIGger:SOURce TIMer +TRIGger:TIMer 0.5 + diff --git a/cpdctrl/update_funcs.py b/cpdctrl/update_funcs.py new file mode 100644 index 0000000..3524db0 --- /dev/null +++ b/cpdctrl/update_funcs.py @@ -0,0 +1,55 @@ +import matplotlib.pyplot as plt +import numpy as np + +from .backends.keithley import keithley + +def _update_print(i, ival, vval): + print(f"n = {i:5d}, I = {ival: .12f} A, U = {vval: .5f} V" + " "*10, end='\r') + +class _Monitor: + """ + Monitor v and i data + """ + def __init__(self, max_points_shown=None, use_print=False): + self.max_points_shown = max_points_shown + self.use_print = use_print + self.index = [] + self.vdata = [] + self.idata = [] + + plt.ion() + self.fig1, (self.vax, self.iax) = plt.subplots(2, 1, figsize=(8, 5)) + + self.vline, = self.vax.plot(self.index, self.vdata, color="g") + self.vax.set_ylabel("Voltage [V]") + self.vax.grid(True) + + self.iline, = self.iax.plot(self.index, self.idata, color="m") + self.iax.set_ylabel("Current [A]") + self.iax.grid(True) + + def update(self, i, ival, vval): + if self.use_print: + _update_print(i, ival, vval) + self.index.append(i) + self.idata.append(ival) + self.vdata.append(vval) + # update data + self.iline.set_xdata(self.index) + self.iline.set_ydata(self.idata) + self.vline.set_xdata(self.index) + self.vline.set_ydata(self.vdata) + # recalculate limits and set them for the view + self.iax.relim() + self.vax.relim() + if self.max_points_shown and i > self.max_points_shown: + self.iax.set_xlim(i - self.max_points_shown, i) + self.vax.set_xlim(i - self.max_points_shown, i) + self.iax.autoscale_view() + self.vax.autoscale_view() + # update plot + self.fig1.canvas.draw() + self.fig1.canvas.flush_events() + + def __del__(self): + plt.close(self.fig1) diff --git a/cpdctrl/utility/__init__.py b/cpdctrl/utility/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/cpdctrl/utility/data.py b/cpdctrl/utility/data.py new file mode 100644 index 0000000..1b82ae2 --- /dev/null +++ b/cpdctrl/utility/data.py @@ -0,0 +1,69 @@ +import pandas as pd +import numpy as np +from os import path +import matplotlib.pyplot as plt + +# deprecated +# def buffer2dataframe(buffer): +# df = pd.DataFrame(buffer) +# df.colums = ["Time [s]", "Voltage [V]"] +# return df + +def buffers2dataframe(ibuffer, vbuffer): + """ + @param ibuffer : 2d - array: timestamps, current + @param vbuffer : 2d - array: timestamps, voltage + @returns DataFrame: timestamps, current, voltage + """ + df = pd.DataFrame(np.vstack((ibuffer[:,0], ibuffer[:,1], vbuffer[:,1])).T) + df.columns = ["Time [s]", "Current [A]", "Voltage [V]"] + return df + +def load_dataframe(p:str): + """ + Load a dataframe from file. + @param p : path of the file. If it has 'csv' extension, pandas.read_csv is used, pandas.read_pickle otherwise + """ + if not path.isfile(p): + print(f"ERROR: load_dataframe: File does not exist: {p}") + return None + if p.endswith(".csv"): + df = pd.read_csv(p) + else: + df = pd.read_pickle(p) + return df + +def plot(data: str or pd.DataFrame or np.ndarray, title="", U=True, I=False): + """ + Plot recorded data + @param data: filepath, dataframe or numpy array + """ + if type(data) == str: + _data = load_dataframe(data).to_numpy() + elif type(data) == pd.DataFrame: + _data = data.to_numpy() + else: + _data = data + print(_data[0]) + plt.ion() + fig, ax = plt.subplots() + ax.set_xlabel("t [s]") + vax = ax + iax = ax + if U and I: + iax = ax.twinx() + if U: + vax = ax + vax.set_ylabel("U [V]") + vax.plot(_data[:,0], _data[:,2], color="blue", label="voltage") + if I: + iax.set_ylabel("I [A]") + iax.plot(_data[:,0], _data[:,1], color="orange", label="current") + if U and I: + plt.legend() + return fig + + + + + diff --git a/cpdctrl/utility/file_io.py b/cpdctrl/utility/file_io.py new file mode 100644 index 0000000..710b16a --- /dev/null +++ b/cpdctrl/utility/file_io.py @@ -0,0 +1,33 @@ +from os import listdir, path + +def add_zeros(v: int, digits=3): + """ + return v as string, add leading zeros if len(str(v)) < digits + """ + s = str(v) + return '0' * (max(digits - len(s), 0)) + s + + +def get_next_filename(basename, directory=".", digits=3): + """ + get the next filename (without extenstion). + example: + basename = file + directory has file001.csv, file002.pkl, file004.csv + -> return file005 + """ + files = listdir(directory) + files.sort() + files.reverse() + lowest_number = -1 + for file in files: + if not file.startswith(basename): continue + try: + number = file[:file.rfind('.')].replace(basename, "") + number = int(number) + if number < lowest_number: continue + lowest_number = number + except ValueError: + continue + + return basename + add_zeros(lowest_number+1) diff --git a/cpdctrl/utility/testing.py b/cpdctrl/utility/testing.py new file mode 100644 index 0000000..c4e9d79 --- /dev/null +++ b/cpdctrl/utility/testing.py @@ -0,0 +1,17 @@ +import numpy as np + +def testcurve(x, frequency=10, peak_width=2, amplitude=20, bias=0): + # 0 = pk - width + # 2pi = pk + width + # want peak at n*time == frequency + nearest_peak = np.round(x / frequency, 0) + # if not peak at 0 and within peak_width + if nearest_peak > 0 and np.abs((x - nearest_peak * frequency)) < peak_width: + # return sin that does one period within 2*peak_width + return amplitude * np.sin(2*np.pi * (x - nearest_peak * frequency - peak_width) / (2*peak_width)) + bias + else: + return bias + +def get_testcurve(frequency=10, peak_width=2, amplitude=20, bias=0): + return np.vectorize(lambda x: testcurve(x, frequency=frequency, peak_width=peak_width, amplitude=amplitude, bias=bias)) + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..5067227 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,41 @@ +[build-system] +requires = ["setuptools"] + +[project] +name = "cpdctrl" +version = "1.1.0" +description = "Utility for voltage measurements with a Keitley 2700 SMU" +requires-python = ">=3.10" +readme = "readme.md" +license = {file = "LICENSE"} +authors = [ + { name = "Matthias Quintern", email = "matthias.quintern@tum.de" } +] +classifiers = [ + "Operating System :: POSIX :: Linux", + "Environment :: Console", + "Programming Language :: Python :: 3", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", +] +dependencies = [ + "matplotlib>=3.6", + "numpy", + "pandas", +] + +[project.optional-dependencies] +keithley = [ + "pyvisa", +] + + + +[project.urls] +repository = "https://git.quintern.xyz/MatthiasQuintern/cpdctrl" + + +[project.scripts] +cpdctrl = "cpdctrl.cpdctrl_interactive:main" + +[tool.setuptools.packages.find] +where = ["."]