diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a842fec --- /dev/null +++ b/.gitignore @@ -0,0 +1,113 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class +*.pyc + +# C extensions +*.so + +*.o + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +doc/_build/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ + +.DS_Store +no_ortho/ +ortho/ +*.zip diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..86fdd15 --- /dev/null +++ b/README.rst @@ -0,0 +1,120 @@ +Prediction IncluDinG INactivity (PIDGIN) Version 3 +======================================== + +|License| + +Author : Lewis Mervin, lhm30@cam.ac.uk + +Supervisor : Dr. A. Bender + +Protein target prediction using `Random Forests`_ (RFs) trained on bioactivity data from PubChem_ (extracted 07/06/18) and ChEMBL_ (version 24), using the RDKit_ and Scikit-learn_, which employ a modification of the reliability-density neighbourhood Applicability Domain (AD) analysis by Aniceto [1]_. This project is the sucessor to PIDGIN `version 1`_ [2]_ and PIDGIN `version 2`_ [3]_. + +* Molecular Descriptors : `2048bit Rdkit Extended Connectivity FingerPrints`_ (ECFP) [4]_ +* Algorithm: `Random Forests`_ with dynamic number of trees (see docs for details), class weight = 'balanced', sample weight = ratio Inactive:Active +* Models generated at four different cut-off's: 100μM, 10μM, 1μM and 0.1μM +* Models generated both with and without mapping to orthologues +* Pathway information from `NCBI BioSystems`_ +* Disease information from `DisGeNET`_ + +Details for sizes across all activity cut-off's: + ++------------------------------------------------+-------------------------+---------------------------+ +| | Without orthologues | With orthologues | ++================================================+=========================+===========================+ +| Distinct Models | 10,446 | 14,678 | ++------------------------------------------------+-------------------------+---------------------------+ +| Distinct Targets [exhaustive total] | 7,075 [7,075] | 16,623 [60,437] | ++------------------------------------------------+-------------------------+---------------------------+ +| Total Bioactivities Over all models | 39,424,168 | 398,340,769 | ++------------------------------------------------+-------------------------+---------------------------+ +| Actives | 3,204,038 | 35,009,629 | ++------------------------------------------------+-------------------------+---------------------------+ +| Inactives [Of which are Sphere Exclusion (SE)] | 36,220,130 [27,435,133] | 363,331,140 [248,782,698] | ++------------------------------------------------+-------------------------+---------------------------+ + +Full details on all models are provided in the uniprot_information.txt files in the orthologue and no_orthologue directories + +INSTRUCTIONS +========================================================================================== + +Development and documentation occurs on GitHub_. + +Install with Conda +---------------------- + +Follow these steps on Linux/OSX: + +1. ``Download and install Anaconda2 for Python 2.7 from https://www.continuum.io/downloads`` + +2. Open terminal in Mac/Linux and run ``conda create -c keiserlab -c rdkit -c sdaxen --name pidgin3_env python=2.7 pip e3fp scikit-learn pydot graphviz`` + +* N.B. Rdkit may not import on some systems due to a bug. If this happens upgrade to the latest version of conda before creating the above environment using: ``conda update conda`` + +3. Now run: ``source activate pidgin3_env`` (This activates the PIDGINv3 virtual environment. N.B This is required for each new terminal session in order to run PIDGIN in the future) + +4. Now run: ``pip install standaridser`` [Installs the IMI eTOX `flatkinson standardiser`_ (replaces ChemAxon's standardizer used in previous PIDGIN versions)] + +5. Navigate the directory you wish to install PIDGINv3 and in Mac/Linux terminal run ``git clone https://github.com/lhm30/PIDGINv3/`` (recommended) or download/extract the zip from `GitHub`_ webpage (not recommended due to inability to pull updates) + +6. Download and unzip `no_ortho.zip`_ into the PIDGINv3 main directory from `https://tinyurl.com/no-ortho`_ (leave all files within data compressed) + +* N.B Depending on bandwidth, Step 6 may take some time + + +IMPORTANT +========================================================================================== + +* You MUST download the models before running! +* The program recognises as input line-separated SMILES in either .smi/.smiles or .sdf format +* If the SMILES input contains data additional to the SMILES string, the first entries after the SMILES are automatically interpreted as identifiers (see the `OpenSMILES specification `_ §4.5) - although there are options to change this behaviour +* Molecules are automatically standardized when running models (can be turned off) +* Do not modify the 'pkls', 'ad_data' etc. names or directories +* cytotox_library.csv and nontoxic_background.csv are included for testing purposes +* For installation and usage instructions, see the `documentation `_. + + +License +------- + +PIDGINv3 is available under the `GNU General Public License v3.0 +`_ (GPLv3). + + +References +---------- + +.. [1] |aniceto| +.. [2] |mervin2015| +.. [3] |mervin2018| +.. [4] |rogers| + + +.. _Random Forests: http://scikit-learn.org/0.19/modules/generated/sklearn.ensemble.RandomForestClassifier.html +.. _PubChem: https://pubchem.ncbi.nlm.nih.gov/ +.. _ChEMBL: https://www.ebi.ac.uk/chembl/ +.. _RDKit: http://www.rdkit.org +.. _Scikit-learn: http://scikit-learn.org/ +.. _version 1: https://github.com/lhm30/PIDGIN +.. _version 2: https://github.com/lhm30/PIDGINv2 +.. _no_ortho.zip : https://tinyurl.com/no-ortho +.. _https://tinyurl.com/no-ortho : https://tinyurl.com/no-ortho +.. _2048bit Rdkit Extended Connectivity FingerPrints: http://www.rdkit.org/docs/GettingStartedInPython.html#morgan-fingerprints-circular-fingerprints +.. _NCBI BioSystems: https://www.ncbi.nlm.nih.gov/Structure/biosystems/docs/biosystems_about.html +.. _DisGeNET: http://www.disgenet.org/web/DisGeNET/menu/dbinfo +.. |aniceto| replace:: Aniceto, N, et al. A novel applicability domain technique for mapping predictive reliability across the chemical space of a QSAR: Reliability-density neighbourhood. *J. Cheminform.* **8**: 69 (2016). |aniceto_doi| +.. |aniceto_doi| image:: https://img.shields.io/badge/doi-10.1186%2Fs13321--016--0182--y-blue.svg + :target: https://doi.org/10.1186/s13321-016-0182-y +.. |mervin2015| replace:: Mervin, L H., et al. Target prediction utilising negative bioactivity data covering large chemical space. *J. Cheminform.* **7**: 51 (2015). |mervin2015_doi| +.. |mervin2015_doi| image:: https://img.shields.io/badge/doi-10.1186%2Fs13321--015--0098--y-blue.svg + :target: https://doi.org/10.1186/s13321-015-0098-y +.. |mervin2018| replace:: Mervin, L H., et al. Orthologue chemical space and its influence on target prediction. *Bioinformatics.* **34**: 72–79 (2018). |mervin2018_doi| +.. |mervin2018_doi| image:: https://img.shields.io/badge/doi-10.1093%2Fbioinformatics%2Fbtx525-blue.svg + :target: https://doi.org/10.1093/bioinformatics/btx525 +.. |rogers| replace:: Rogers D & Hahn M. Extended-connectivity fingerprints. *J. Chem. Inf. Model.* **50**: 742-54 (2010). |rogers_doi| +.. |rogers_doi| image:: https://img.shields.io/badge/doi-10.1021/ci100050t-blue.svg + :target: http://dx.doi.org/10.1021/ci100050t +.. _GitHub: https://github.com/lhm30/PIDGINv3 +.. _flatkinson standardiser: https://github.com/flatkinson/standardiser +.. _models.zip: +.. |license| image:: https://img.shields.io/badge/license-GPLv3-blue.svg + :target: https://github.com/lhm30/PIDGINv3/blob/master/LICENSE.txt diff --git a/predict.py b/predict.py new file mode 100644 index 0000000..6cde94c --- /dev/null +++ b/predict.py @@ -0,0 +1,436 @@ +#Author : Lewis Mervin lhm30@cam.ac.uk +#Supervisor : Dr. A. Bender +#All rights reserved 2018 +#Protein Target Prediction using on SAR data from PubChem and ChEMBL_24 +#Molecular Descriptors : 2048bit circular Binary Fingerprints (Rdkit) - ECFP_4 +#Dependencies : rdkit, sklearn, standardiser + +### predict.py ### +#Output a matrix of probabilities [computed as the mean predicted class probabilities of +#the trees in the forest (where the class probability of a single tree is the fraction of +#samples of the same class in a leaf)], or user-specified Random probability thresholds to +#produce binary predictions for an input list of smiles/sdfs. Predictions are generated +#for the [filtered] models using a reliability-density neighbourhood Applicability Domain +#(AD) analysis from: doi.org/10.1186/s13321-016-0182-y + +#libraries +import os +import sys +import bz2 +import zipfile +import cPickle +import glob +import time +import math +import numpy as np +from rdkit import Chem +from rdkit.Chem import AllChem +from rdkit import DataStructs +from rdkit.Chem import Descriptors +from scipy.stats import percentileofscore +import multiprocessing +from multiprocessing import Pool +from optparse import OptionParser + +#optionparser options +parser = OptionParser() +parser.add_option("-f", dest="inf", help="Input smiles or sdf file (required)", metavar="FILE") +parser.add_option("-d", "--smiles_delim", default=' ', type=str, dest="delim", help="Input file (smiles) delimiter char (default: white space ' ')") +parser.add_option("--smiles_column", default=0, type=int, dest="smicol", help="Input file (smiles) delimiter column (default: 0)") +parser.add_option("--smiles_id_column", default=1, type=int, dest="idcol", help="Input file (smiles) ID column (default: 1)") +parser.add_option("-o", dest="off", default=None, help="Optional output prediction file name", metavar="FILE") +parser.add_option("-t", "--transpose", action="store_true", default=False, dest="transpose", help="Transpose output (rows are compounds, columns are targets)") +parser.add_option("-n", "--ncores", default=1, type=int, dest="ncores", help="No. cores (default: 1)") +parser.add_option("-b", "--bioactivity", default=None, type=str, dest="bioactivity", help="Bioactivity threshold (can use multiple split by ','. E.g. '100,10'") +parser.add_option("-p", "--proba", default=None, type=float, dest="proba", help="RF probability threshold (default: None)") +parser.add_option("--ad", default='90', type=str, dest="ad", help="Applicability Domain (AD) filter using percentile of weights [float]. Default: 90 (integer for percentile)") +parser.add_option("--known_flag", action="store_true", default=False, dest="known", help="Set known activities (annotate duplicates betweem input to train with correct label)") +parser.add_option("--orthologues", action="store_true", default=False, dest="ortho", help="Set to use orthologue bioactivity data in model generation") +parser.add_option("--organism", dest="organism", default=None, type=str, help="Organism filter (multiple can be specified using commas ',')") +parser.add_option("--target_class", dest="targetclass", default=None, type=str, help="Target classification filter") +parser.add_option("--min_size", dest="minsize", default=10, type=int, help="Minimum number of actives used in model generation (default: 10)") +parser.add_option("--performance_filter", default=None, type=str, dest="p_filt", help="Comma-seperated performance filtering using following nomenclature: validation_set[tsscv,l50so,l50po],metric[bedroc,roc,prauc,brier],performance_threshold[float]. E.g 'tsscv,bedroc,0.5'") +parser.add_option("--se_filter", action="store_true", default=False, dest="se_filt", help="Optional setting to restrict to models which do not require Sphere Exclusion (SE)") +parser.add_option("--training_log", action="store_true", default=False, dest="train_log", help="Optional setting to add training_details to the prediction file (large increase in output file size)") +parser.add_option("--ntrees", dest="ntrees", default=None, type=int, help="Specify the minimum number of trees for warm-start random forest models (N.B Potential large latency/memory cost)") +parser.add_option("--preprocess_off", dest="preproc", action="store_false", default=True, help="Turn off preprocessing using the flatkinson (eTox) standardizer (github.com/flatkinson/standardiser), size filter (100 >= Mw >= 1000 and organic mol check (C count >= 1)") +parser.add_option("--std_dev", dest="std", action="store_true", default=False, help="Turn on matrix calculation for the standard deviation of prediction across the trees in the forest") +parser.add_option("--percentile", dest="percentile", action="store_true", default=False, help="Turn on matrix calculation for the percentile of AD compounds") + +(options, args) = parser.parse_args() +#if tab delimited then set to \t +if options.delim == 'tab': options.delimcol1 = '\t' + +def introMessage(): + print '==============================================================================================' + print ' Author: Lewis Mervin\n Email: lhm30@cam.ac.uk\n Supervisor: Dr. A. Bender' + print ' Address: Centre For Molecular Informatics, Dept. Chemistry, Lensfield Road, Cambridge CB2 1EW' + print '==============================================================================================\n' + return + +#check smiles of sdf (if not quit) +def check_Input(): + global options + extension = options.inf.split('.')[-1] + if extension not in ['smi','smiles','sdf']: + print ' Warning [-f]: File type not "smi", "smiles" or "sdf". Interpreting input as SMILES' + return extension + +#check input & set OS directory pointers +def check_set_working_env(): + global options + if os.name == 'nt': sep = '\\' + else: sep = '/' + input_extension = check_Input() + try: + ad_settings = int(options.ad) + if 0 >= ad_settings >= 100: raise ValueError + except ValueError: + print ' Input Error [--ad]: Percentile weight not integer between 0-100%. Please Check parameters' + sys.exit() + pidgin_dir = os.path.dirname(os.path.abspath(__file__)) + if options.ortho: + mod_dir = pidgin_dir + sep + 'data' + sep + 'ortho' + sep + if not os.path.isdir(mod_dir): + print ' Orthologue Error [--orthologues]: Orthologues directory is not present. Please download from here: ' + else: mod_dir = pidgin_dir + sep + 'data' + sep + 'no_ortho' + sep + return input_extension, sep, pidgin_dir, mod_dir, ad_settings + +#filter models using user specification supplied via option parser +def get_Models(): + global mod_dir, sep, options + target_count = 0 + model_info = [l.split('\t') for l in open(mod_dir + 'training_log.txt').read().splitlines()] + if options.ntrees: model_info = [m[:2]+[str(options.ntrees)]+m[3:] if idx > 0 else m \ + for idx, m in enumerate(model_info)] + model_info = {l[0] : l for l in model_info} + uniprot_info = [i.split('\t') for i in open(mod_dir + 'uniprot_information.txt').read().splitlines()[1:]] + mid_uniprots = dict() + if options.p_filt: + val_dict = {'tsscv':7, 'l50po':12, 'l50so':17} + metric_dict = dict(zip(['bedroc','roc','prauc','brier'],range(4))) + try: + (validation,metric,perf_threshold) = [pf.lstrip() for pf in options.p_filt.split(',')] + train_row_idx = val_dict[validation] + metric_dict[metric] + perf_threshold = float(perf_threshold) + print ' Filtering models for a minimum ' + metric + ' performance of ' \ + + str(perf_threshold) + ' during ' + validation + ' validaiton' + except (KeyError,ValueError): + print ' Input Error [--performance_filter]: Use format ' \ + 'validation_set[tsscv,l50so,l50po],metric[bedroc,roc,prauc,brier],' \ + 'threshold[float].\n E.g "bedroc,tsscv,0.5"\n...exiting' + sys.exit() + if options.organism: orgs = map(str.lower, options.organism.split(',')) + for row in uniprot_info: + #filter bioactivity/organism/targetclass/minsize/se/performance (if set) + if options.bioactivity and row[8] not in options.bioactivity.split(','): continue + if options.organism and (row[4] == '' \ + or not any([org.lstrip() in row[4].lower() for org in orgs])): continue + if options.targetclass and row[3] not in options.targetclass: continue + if sum(map(int,row[9:11])) < options.minsize: continue + if options.se_filt and int(row[13]) > 0: continue + if options.p_filt: + try: + if float(model_info[row[-1]][train_row_idx].split(',')[0]) < perf_threshold: continue + except ValueError: continue + #if passes all filters then add to mid->uniprot dictionary + try: mid_uniprots[row[-1]].append(row) + except KeyError: mid_uniprots[row[-1]] = [row] + target_count +=1 + if len(mid_uniprots) == 0: + print ' Warning: No eligable models using current filters...exiting' + sys.exit() + return mid_uniprots, model_info, target_count + +#preprocess rdkit molecule +def preprocessMolecule(inp): + def checkC(mm): + mwt = Descriptors.MolWt(mm) + for atom in mm.GetAtoms(): + if atom.GetAtomicNum() == 6 and 100 <= mwt <= 1000: return True + return False + def checkHm(mm): + for atom in mm.GetAtoms(): + if atom.GetAtomicNum() in [2,10,13,18]: return False + if 21 <= atom.GetAtomicNum() <= 32: return False + if 36 <= atom.GetAtomicNum() <= 52: return False + if atom.GetAtomicNum() >= 54: return False + return True + try: std_mol = standardise.run(inp) + except standardise.StandardiseException: return None + if not std_mol or checkHm(std_mol) == False or checkC(std_mol) == False: return None + else: return std_mol + +#preprocess exception to catch +class MolFromSmilesError(Exception): + 'raise due to "None" from Chem.MolFromSmiles' + +#preprocess exception to catch +class PreprocessViolation(Exception): + 'raise due to preprocess violation' + +#calculate 2048bit morgan fingerprints, radius 2, for smiles or sdf input +def calcFingerprints(input,qtype='smiles'): + if qtype == 'smiles': m = Chem.MolFromSmiles(input) + else: m = input + if not m: raise MolFromSmilesError(' None mol in function') + if options.preproc: + m = preprocessMolecule(m) + if not m: raise PreprocessViolation(' Molecule preprocessing violation') + fp = AllChem.GetMorganFingerprintAsBitVect(m,2, nBits=2048) + binary = fp.ToBitString() + if qtype == 'sdf': return Chem.MolToSmiles(m), map(int,list(binary)), fp + else: return map(int,list(binary)), fp + +#calculate fingerprints for chunked array of smiles +def arrayFP(inp): + outfp = [] + outmol = [] + outsmi_id = [] + for idx, i in inp: + i = i.split(options.delim) + try: + fp, mol = calcFingerprints(i[options.smicol]) + outfp.append(fp) + outmol.append(mol) + try: outsmi_id.append(i[options.idcol]) + except IndexError: outsmi_id.append(i[options.smicol]) + except PreprocessViolation: print ' SMILES preprocessing violation (line ' + str(idx+1) + ' will be removed): ' + i[options.smicol] + except MolFromSmilesError: print ' SMILES parse error (line ' + str(idx+1) + '): ' + i[options.smicol] + return outfp, outmol, outsmi_id + +#import user smiles query +def importQuerySmiles(in_file): + query = open(in_file).read().splitlines() + query = zip(range(len(query)),query) + matrix = np.empty((len(query), 2048), dtype=np.uint8) + smiles_per_core = int(math.ceil(len(query) / options.ncores)+1) + chunked_smiles = [query[x:x+smiles_per_core] for x in xrange(0, len(query), smiles_per_core)] + pool = Pool(processes=options.ncores) # set up resources + jobs = pool.imap(arrayFP, chunked_smiles) + current_end = 0 + processed_mol = [] + processed_id = [] + for i, result in enumerate(jobs): + percent = (float(i)/float(len(chunked_smiles)))*100 + 1 + sys.stdout.write(' Processing Molecules: %3d%%\r' % percent) + sys.stdout.flush() + matrix[current_end:current_end+len(result[0]), :] = result[0] + current_end += len(result[0]) + processed_mol += result[1] + processed_id += result[2] + pool.close() + pool.join() + print + return matrix[:current_end], processed_mol, processed_id + +#preprocess exception to catch +class SdfNoneMolError(Exception): + 'raised due to "None" mol during enumeration through Chem.SDMolSupplier' + +#import user query for sdf +def importQuerySDF(in_file): + outfp = [] + outid= [] + outmol = [] + query = Chem.SDMolSupplier(in_file) + for idx, m in enumerate(suppl): + sys.stdout.write(' Importing SDF file. Compound number: %s\r' % idx) + sys.stdout.flush() + try: + if not m: raise SdfNoneMolError('None mol') + smi, fp, mol = calcFingerprints(m,qtype='sdf') + try: outid.append(m.GetProp("_Name")) + except KeyError: outid.append(smi) + outfp.append(fp) + outmol.append(mol) + except SdfNoneMolError: print ' SDF parse error (compound index: ' + str(idx) + ')' + print + return np.array(outfp,dtype=np.uint8),outmol,outid + +#unzip a pkl model +def open_Model(mod): + global mod_dir, options + with bz2.BZ2File(mod_dir + 'pkls' + sep + mod + '.pkl.bz2', 'rb') as bzfile: + clf = cPickle.load(bzfile) + #if set, increase number of trees in forest + if options.ntrees and clf.n_estimators < options.ntrees: + clf.set_params(n_estimators=options.ntrees) + return clf + +#import the training data similarity, bias and standard deviation file for given model +def getAdData(model_name): + global mod_dir, sep + actual_mid = model_name.split('/')[-1].split('.pkl.bz2')[0] + ad_file = mod_dir + 'ad_analysis' + sep + actual_mid + '.pkl.bz2' + with bz2.BZ2File(ad_file, 'rb') as bzfile: + ad_data = cPickle.load(bzfile) + return ad_data + +#perform AD analysis using full similarity weighted threshold [similarity/(bias * std_dev] +#adapted from DOI:10.1186/s13321-016-0182-y +def doSimilarityWeightedAdAnalysis(model_name): + global rdkit_mols, ad_settings + ad_idx = [] + known = [] + ad_data = getAdData(model_name) + required_threshold = np.percentile(ad_data[:,5],ad_settings) + for mol_idx, m in enumerate(rdkit_mols): + ad_flag = False + #only check for known compounds if set in options (True means dont check) + if options.known: k_flag = False + else: k_flag = True + for training_instance in ad_data: + sim = DataStructs.TanimotoSimilarity(m,training_instance[0]) + if sim == 1.0 and k_flag == False: + known.append([mol_idx,training_instance[1]]) + k_flag = True + weight = sim/(training_instance[2]*training_instance[3]) + if weight >= required_threshold and ad_flag != True: + ad_idx.append(mol_idx) + ad_flag = True + #if compound is in AD and no need to check accross all comps for known then break + if k_flag == True and ad_flag == True: break + return ad_idx, np.array(known) + +#return percentile AD analysis for [similarity/(bias * std_dev] vs training data +def doPercentileSimilarityWeightedAdAnalysis(model_name): + global rdkit_mols,ad_settings + ret = [] + ad_data = getAdData(model_name) + for mol_idx, m in enumerate(rdkit_mols): + percentiles = [] + for training_instance in ad_data: + sim = DataStructs.TanimotoSimilarity(m,training_instance[0]) + weight = sim/(training_instance[2]*training_instance[3]) + percentiles.append(percentileofscore(ad_data[:,5],weight)) + ret.append(max(percentiles)) + return ret + +#calculate standard deviation for an input compound +def getStdDev(clf, querymatrix): + std_dev = [] + for tree in range(len(clf.estimators_)): + std_dev.append(clf.estimators_[tree].predict_proba(querymatrix)[:,1]) + std_dev = np.clip(np.std(std_dev,axis=0),0.001,None) + return std_dev + +#raw or binary prediction worker +def doTargetPrediction(model_name): + global ad_settings + if options.percentile: return model_name, doPercentileSimilarityWeightedAdAnalysis(model_name) + clf = open_Model(model_name) + ret = np.zeros(len(querymatrix)) + ret.fill(np.nan) + #percentile ad analysis calculated from [near_neighbor_similarity/(bias*deviation)] + try: + ad_idx, known = doSimilarityWeightedAdAnalysis(model_name) + except: return model_name, ret + #if no mols in AD then return + if len(ad_idx) == 0: return model_name, ret + probs = clf.predict_proba(querymatrix[ad_idx])[:,1].clip(0.001,0.999) + #return the standard deviation if turned on + if options.std: + std_dev = getStdDev(clf,querymatrix) + ret[ad_idx] = std_dev[ad_idx] + return model_name, ret + #will only have known if was set on + if len(known) > 0: probs[known[:,0]] = known[:,1] + if threshold: ret[ad_idx] = map(int,probs > threshold) + else: ret[ad_idx] = probs + return model_name, ret + +#prediction runner for prediction or standard deviation calculation +def performTargetPrediction(models): + prediction_results = [] + pool = Pool(processes=options.ncores, initializer=initPool, initargs=(querymatrix,options.proba,)) + jobs = pool.imap_unordered(doTargetPrediction, models) + for i, result in enumerate(jobs): + percent = (float(i)/float(len(models)))*100 + 1 + sys.stdout.write(' Performing Classification on Query Molecules: %3d%%\r' % percent) + sys.stdout.flush() + if prediction_results is not None: prediction_results.append(result) + pool.close() + pool.join() + return prediction_results + +#write out normal results (rows are targets, columns are compounds) +def writeOutResults(results): + global query_id, mid_uniprots, model_info, options + out_data = [] + for mid, preds in results: + for uniprot_rows in mid_uniprots[mid]: + if options.train_log: out_data += [uniprot_rows + model_info[mid][1:] + list(preds)] + else: out_data += [uniprot_rows + list(preds)] + timestr = time.strftime("%Y%m%d-%H%M%S") + if not options.off: output_name = options.inf + '_out_predictions_' + timestr + '.txt' + else: output_name = options.off + '_out_predictions_' + timestr + '.txt' + print ' Writing predictions to file: ' + output_name + out_file = open(output_name, 'w') + header = 'Uniprot\tName\tGene_ID\tProtein_Classification\tOrganism' \ + '\tPDB_IDs\tDisGeNET_0.06\tChEMBL_First_Publication\tActivity_Threshold' \ + '\tActives\tOrthologue_Actives\tInactives\tOrthologue_Inactives' \ + '\tSphere_Exclusion_Inactives\tRatio\tModel_ID\t' + if options.train_log: out_file.write(header + \ + '\t'.join(map(str,model_info['MODEL_ID'][1:])) + '\t' + '\t'.join(map(str,query_id)) + '\n') + else: + out_file.write(header + '\t'.join(map(str,query_id)) + '\n') + for row in out_data: out_file.write('\t'.join(map(str,row)) + '\n') + out_file.close() + return + +#write out transposed results (columns are targets, rows are compounds) +def writeOutTransposed(results): + global query_id, mid_uniprots, model_info, options + out_data = [['Uniprot'] + query_id] + for mid, preds in results: + for uniprot_rows in mid_uniprots[mid]: + out_data += [[uniprot_rows[0]] + list(preds)] + timestr = time.strftime("%Y%m%d-%H%M%S") + if not options.off: output_name = options.inf + '_out_predictions_' + timestr + '.txt' + else: output_name = options.off + 'lx -l_out_predictions_' + timestr + '.txt' + print ' Writing out transposed predictions to file: ' + output_name + out_file = open(output_name, 'w') + out_data = np.transpose(out_data) + for row in out_data: out_file.write('\t'.join(map(str,row)) + '\n') + out_file.close() + return + +#nt (Windows) compatibility initializer for the pool +def initPool(querymatrix_, threshold_): + global querymatrix, threshold + querymatrix = querymatrix_ + threshold = threshold_ + +#main +if __name__ == '__main__': + introMessage() + print ' Predicting Targets for input: ' + options.inf + print ' Using ' + str(options.ncores) + ' core(s)' + if options.ntrees: print 'Latency warning: Number of trees will be increased to minimum: ' + str(options.ntrees) + print ' Using bioactivity thresholds (IC50/EC50/Ki/Kd) of : ' + str(options.bioactivity) + print ' Using orthologues: ' + str(options.ortho) + if options.organism: print ' Organism filter : ' + options.organism + if options.targetclass: print ' Target class filter : ' + options.targetclass + if options.minsize: print ' Minimum number of actives in training : ' + str(options.minsize) + if options.se_filt: print ' Filtering out models with Sphere Exclusion (SE)' + if options.train_log: print ' Training log will be added to output' + #set up environment + input_extension, sep, pidgin_dir, mod_dir, ad_settings = check_set_working_env() + #if preprocessing import standardizer + if options.preproc: from standardiser import standardise + #gather the models required and their information + mid_uniprots, model_info, target_count = get_Models() + print ' Total number of protein targets: ' + str(target_count) + print ' Total number of distinct models: ' + str(len(mid_uniprots)) + print ' Using p(activity) threshold of: ' + str(options.proba) + print ' Importing query (calculating ECFP_4 finerprints)' + #import user query files + if input_extension == 'sdf': querymatrix,rdkit_mols,query_id = importQuerySDF(options.inf) + else: querymatrix,rdkit_mols,query_id = importQuerySmiles(options.inf) + print ' Total number of query molecules : ' + str(len(querymatrix)) + #perform target prediction on (filtered) models (using model ids) + prediction_results = performTargetPrediction(mid_uniprots.keys()) + #write out + if options.transpose: writeOutTransposed(prediction_results) + else: writeOutResults(prediction_results) \ No newline at end of file