From ed6a9e880710eead6d5092d4d281a649cf538e07 Mon Sep 17 00:00:00 2001 From: Adrien Bourmault Date: Tue, 2 Nov 2021 17:54:30 +0100 Subject: [PATCH 01/11] WIP: new GUI window with GTK3 --- .gitlab-ci.yml | 11 + LICENSE | 661 ++++++++++++++++++++++++++++++++++ contributing.md | 161 +++++++++ models/dimers random walk.xml | 113 ++++++ requirements.txt | 0 schemas/models_0.2.xmls | 199 ++++++++++ src/main.py | 53 +++ 7 files changed, 1198 insertions(+) create mode 100644 .gitlab-ci.yml create mode 100644 LICENSE create mode 100644 contributing.md create mode 100644 models/dimers random walk.xml create mode 100644 requirements.txt create mode 100644 schemas/models_0.2.xmls create mode 100644 src/main.py diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..d27c286 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,11 @@ +before_script: + - python --version + - pip install -r requirements.txt + +stages: + - Static Analysis + +flake8: + stage: Static Analysis + script: + - flake8 --max-line-length=120 --ignore=E402,E266, src/*.py \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..15c6e41 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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) 2021 Adrien Bourmault + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..2367e09 --- /dev/null +++ b/contributing.md @@ -0,0 +1,161 @@ +# Gem-graph Client + +A gem-graph client can be used to: + +- create or edit a gem-graph model +- control a run of a gem-graph model by a gem-graph server +- get and study the results of such a run + +--- + +In order to execute these functions, it must be able to manage: + +inputs / outputs + + - load and save models + - use xml schemas to check the validity of models + - connect to an instance of gem-graph server + - dialog with this instance + +a GUI able to: + + - render and edit the model + - states + - objects types + - tags and references + - transitions (edition 'de novo' or starting from a state copy) + - transitions trees + - users trees + + - control a run using commands: + - run / stop + - speed up / slow down + - do / undo / redo + - predefine run duration, sampling frequency and nature + - predefine interruption parameters + (according to server performances and/or model results) + - preselect the search algorithm in the conditions tree + + - monitor performances of the server + + - view and analyse the results of a run + - history + - phase diagrams (structures / fluxes) + - statistics + - errors + + - facilitate usage of the software + - preferences + - context info + - help + +--- + +Definitions (see also: gem graph README and gem graph server README) + +1) XML Schema + +- According to the model xml schema, + a gem-graph model must include at least the following data groups: + + + identity (name, owner, creation date, version, references,...) + + parameters (about simulation and space: dimension, size x y z,...) + + objects: each object is a connex graph drawn as a set of arrows + + savestates: each state (objects, situations, tags) is drawn as a set of arrows + + transitions: each transition is defined as two sets of arrows + + conditions: that are specified as nodes in a tree (see below) + + +2) Automaton rewriting a geometric graph + +- A gem-graph is a geometric graph = a graph whose nodes have coordinates in a space. +- A gem-graph model describes an automaton that can rewrite a gem-graph. +- An automaton that can rewrite a gem-graph has to define states and transitions. + +- States belong to a unique global space in which all the transitions occur. +- Each transition rewrites a part of the global space. This part is called the local space. + +- States are drawn in spaces (global or local) using arrows. +- States can be combinations of objects, situations and/or tags. +- Objects and tags are connex graphs (i.e. graphs whose nodes are all connected). +- A situation describes the relative positions of several objects in the global space. +- A tag is a part of an object or situation which encodes a human readable text (annotation, ref, value,...). + +- Several connex graphs can be used to describe the same object. +- An instance of the class object groups all these graphs plus some comments or values. + +- Transitions are defined by an initial and a final local states. +- The initial state of a transition can be evaluated by a set of conditions. +- Each condition is defined as the association of: + + + a location (space unit (x, y, z) and site number) + + an arrow number (or weight) as several arrows can be stacked at the same location + + +- All the conditions can be ordered in a single tree: the 'tree of conditions' (see below). +- In the XML model file, in order to write and read this tree, + each condition has a node identifier (node_id) and a parent. + + +3) Data structures + +- Arrows are represented (encoded) by numbers in sites. +- In each space units is a finite number of sites. +- The site 0 always points towards its own space unit. +- Each other site points towards a neighbouring (not necessarily adjacent) state unit. +- Each site of each space unit can 'contain' 0 or n arrows. +- The set of states of all the sites of all the space units defines a space state. + +- A condition is satisfied if both following quantities are equal: + + the number of arrows (or weights) specified by the condition + + the number of arrows present in the space at the same location specified by the condition. + + +- When conditions are evaluated by the automaton, these two values are compared. +- These evaluations are done by threads (workers) managed by the scheduler of the server. + +- A transition rule associates several conditions to several assignments. +- An assignment instruction assigns a number (n) of arrows to a site of a space unit of the global space. + +- The conditions of a transition rule must all be satisfied for this rule to be applied. + +- Several transition rules can have conditions that read the same site. +- As all the transition rules share at least one common conditions on the local space origin, + all the conditions of all the transition rules can be ordered as a single conditions tree. +- In this conditions tree, each condition is a node and each set of assignments is a leave. +- The root of this tree is the condition on the local space origin. +- The other conditions are met by following a predefined path through all the locations of the local space. +- This path is determined by the user according to the design and performances of the model. +- In the XML model file, in order to write and read the conditions tree, each condition has a node identifier and a parent. + + +4) Algorithms + +- The search of a transition rule in the conditions tree is done by the threads of the scheduler (see gem-graph-server README) +- The result of these searches can be: + + success (the founded rule is applied) + + failure (there is no rule for this situation; the local situation is returned to the client) + + error + +- The rules and the conditions tree are designed by the client and executed by the server scheduler threads. + It is the responsability of the user to manage: + + conditions deficit, conflicts and redundancy + + rules deficit, conflicts and redundancy + + optimisation of the conditions tree by design of an adequate path through all the locations of the local space + + approximations of objects, situations and phenomena + + +5) Meta-edition (future) + +- As mentionned above, several connex graphs can be used to describe the same object. +- An instance of the class object, called a meta-object, then groups all these graphs plus some comments or values. + +- In future versions, the client should provide tools in order to help model designers to edit + + objects from meta-objects. (vectorisation) + + transitions from meta-transitions. (AI ?) + + +NB Adequate data structures should describe these meta-transitions and meta-objets. + + +--- diff --git a/models/dimers random walk.xml b/models/dimers random walk.xml new file mode 100644 index 0000000..c5696fd --- /dev/null +++ b/models/dimers random walk.xml @@ -0,0 +1,113 @@ + + + + + Modèle de test + + Gaston Lagaffe + + 2 + + 1629830000 + + 1.0 + + Ref + + + + + + 0 + 9 + + + + + 1 + + + + + 3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e69de29 diff --git a/schemas/models_0.2.xmls b/schemas/models_0.2.xmls new file mode 100644 index 0000000..a4f255d --- /dev/null +++ b/schemas/models_0.2.xmls @@ -0,0 +1,199 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/main.py b/src/main.py new file mode 100644 index 0000000..342e2b6 --- /dev/null +++ b/src/main.py @@ -0,0 +1,53 @@ +#!/usr/bin/python3 +# ------------------------------------------------------------------------- # +# Client main file # +# # +# Copyright © 2021 The Gem-graph Project # +# # +# This file is part of gem-graph. # +# # +# This program is free software: you can redistribute it and/or modify # +# it under the terms of the GNU Affero 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 Affero General Public License for more details. # +# # +# You should have received a copy of the GNU Affero General Public License # +# along with this program. If not, see . # +# ------------------------------------------------------------------------- # + +import gi +gi.require_version("Gtk", "3.0") +from gi.repository import Gtk +from lxml import etree + + +modelPath = "../models/dimers random walk.xml" +schemPath = "../schemas/models_0.2.xmls" + +tree = etree.parse(modelPath) + +## Main window + + +class MyWindow(Gtk.Window): + + def __init__(self): + super().__init__(title="Hello World") + + self.button = Gtk.Button(label="Click Here") + self.button.connect("clicked", self.on_button_clicked) + self.add(self.button) + + def on_button_clicked(self, widget): + print("Hello World") + + +win = MyWindow() +win.connect("destroy", Gtk.main_quit) +win.show_all() +Gtk.main() From c5775b5e650b0e983211bf53fd91e0f9b8863627 Mon Sep 17 00:00:00 2001 From: Adrien Bourmault Date: Tue, 2 Nov 2021 17:05:35 +0000 Subject: [PATCH 02/11] Update contributing.md --- contributing.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/contributing.md b/contributing.md index 2367e09..9eb3ab9 100644 --- a/contributing.md +++ b/contributing.md @@ -1,5 +1,38 @@ # Gem-graph Client +## Procédure de développement (Bonnes pratiques) + +### Une seule branche par fonctionnalité : dev/ + + git fetch origin // récupère les branches sur le remote (git.a-lec.org) + git switch devel // car on part toujours de la branche devel + git branch dev/ + git switch dev/ + git push --set-upstream origin dev/ // dit au serveur que la branche existe + + [...] + +Une fois fonctionnalité terminée et push accompli, ouvrir une merge request à +l'aide du lien fourni par git push + + +### Lors du travail sur une branche (les [...] du premier point) + +Pour chaque session de travail : + + git pull + [...] + git commit -am "WIP: " + git push + +Une fois terminée la fonctionnalité et s'il y a un objectif de version : + + git tag -a vM.m.p -m "Fonctionnalité terminée" + git commit -am "Fonctionnalité terminée" + git push + +## Objectifs de développement + A gem-graph client can be used to: - create or edit a gem-graph model From cd5a8f35d13a211edb8b46c601477d255451f70a Mon Sep 17 00:00:00 2001 From: Jean Sirmai Date: Thu, 4 Nov 2021 17:04:05 +0000 Subject: [PATCH 03/11] In model xml, space-param.dimension includes as many children as there are dimensions --- models/dimers random walk.xml | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/models/dimers random walk.xml b/models/dimers random walk.xml index c5696fd..c6a063d 100644 --- a/models/dimers random walk.xml +++ b/models/dimers random walk.xml @@ -1,4 +1,4 @@ - + @@ -24,8 +24,15 @@ - 1 - + + + + + + + + + From ee24c4700a183d009c9ad1da0b5b6854e119a938 Mon Sep 17 00:00:00 2001 From: Jean Sirmai Date: Fri, 5 Nov 2021 19:38:24 +0100 Subject: [PATCH 04/11] new space-param dimension format --- models/dimers random walk.xml | 7 ++++--- schemas/models_0.2.xmls | 24 ++++++++++++++++++------ 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/models/dimers random walk.xml b/models/dimers random walk.xml index c6a063d..e2ef414 100644 --- a/models/dimers random walk.xml +++ b/models/dimers random walk.xml @@ -29,9 +29,9 @@ - - - + + + @@ -118,3 +118,4 @@ + diff --git a/schemas/models_0.2.xmls b/schemas/models_0.2.xmls index a4f255d..af1ed02 100644 --- a/schemas/models_0.2.xmls +++ b/schemas/models_0.2.xmls @@ -48,6 +48,18 @@ + + + + + + + + + + + + @@ -137,13 +149,13 @@ - - - - - + + + + + - + From f62ea44c3f5ef826da66368b36df4fc8f47c1cfd Mon Sep 17 00:00:00 2001 From: Adrien Bourmault Date: Thu, 11 Nov 2021 15:17:38 +0000 Subject: [PATCH 05/11] Apply 1 suggestion(s) to 1 file(s) --- models/dimers random walk.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/models/dimers random walk.xml b/models/dimers random walk.xml index e2ef414..924c7bd 100644 --- a/models/dimers random walk.xml +++ b/models/dimers random walk.xml @@ -29,7 +29,7 @@ - + From a5d1b055588d5fc172fd51ae4288ba25603ca5f7 Mon Sep 17 00:00:00 2001 From: Adrien Bourmault Date: Thu, 11 Nov 2021 15:18:55 +0000 Subject: [PATCH 06/11] Apply 1 suggestion(s) to 1 file(s) --- schemas/models_0.2.xmls | 1 - 1 file changed, 1 deletion(-) diff --git a/schemas/models_0.2.xmls b/schemas/models_0.2.xmls index af1ed02..d66f5fa 100644 --- a/schemas/models_0.2.xmls +++ b/schemas/models_0.2.xmls @@ -55,7 +55,6 @@ - From 92e03a7450a5423fee1f18ef1e3b271a69e41431 Mon Sep 17 00:00:00 2001 From: Adrien Bourmault Date: Thu, 11 Nov 2021 15:19:04 +0000 Subject: [PATCH 07/11] Apply 1 suggestion(s) to 1 file(s) --- schemas/models_0.2.xmls | 1 - 1 file changed, 1 deletion(-) diff --git a/schemas/models_0.2.xmls b/schemas/models_0.2.xmls index d66f5fa..2c8a0a9 100644 --- a/schemas/models_0.2.xmls +++ b/schemas/models_0.2.xmls @@ -55,7 +55,6 @@ - From 0ad210b930330090ea4c1dd58cd74b0d6c508221 Mon Sep 17 00:00:00 2001 From: Adrien Bourmault Date: Thu, 11 Nov 2021 15:19:17 +0000 Subject: [PATCH 08/11] Apply 1 suggestion(s) to 1 file(s) --- models/dimers random walk.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/models/dimers random walk.xml b/models/dimers random walk.xml index 924c7bd..64d48f4 100644 --- a/models/dimers random walk.xml +++ b/models/dimers random walk.xml @@ -30,7 +30,7 @@ - + From 544a34de7c4eee164f057adada84b81cffafd619 Mon Sep 17 00:00:00 2001 From: Adrien Bourmault Date: Thu, 11 Nov 2021 15:20:17 +0000 Subject: [PATCH 09/11] Apply 1 suggestion(s) to 1 file(s) --- models/dimers random walk.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/models/dimers random walk.xml b/models/dimers random walk.xml index 64d48f4..16439a2 100644 --- a/models/dimers random walk.xml +++ b/models/dimers random walk.xml @@ -31,7 +31,7 @@ - + From 16eb05fa05f1f1582e7460f1e124a177445b13b6 Mon Sep 17 00:00:00 2001 From: Jean Sirmai Date: Sun, 5 Dec 2021 17:44:05 +0100 Subject: [PATCH 10/11] WIP: XMLS non redondant et renommages --- models/dimers random walk.xml | 88 +++++++++++++++++----------------- schemas/models_0.2.xmls | 90 ++++++++++++----------------------- 2 files changed, 74 insertions(+), 104 deletions(-) diff --git a/models/dimers random walk.xml b/models/dimers random walk.xml index 16439a2..dd1e7a1 100644 --- a/models/dimers random walk.xml +++ b/models/dimers random walk.xml @@ -1,22 +1,20 @@ - Modèle de test - Gaston Lagaffe + Léontine Patinette 2 - 1629830000 + 1630000000 1.0 - Ref + Ref - - + 0 9 @@ -24,18 +22,19 @@ - - - - + + + + + 3 @@ -43,50 +42,50 @@ - - - - - + + + + + + - - - - - - - - - - - + + + + + + + + + + - + - + - + - - - + + + - + - + @@ -95,27 +94,26 @@ - - - - - + + + + - - - - - + + + + - diff --git a/schemas/models_0.2.xmls b/schemas/models_0.2.xmls index 2c8a0a9..f106f88 100644 --- a/schemas/models_0.2.xmls +++ b/schemas/models_0.2.xmls @@ -1,9 +1,9 @@ - + @@ -11,12 +11,7 @@ - - - - - @@ -27,14 +22,6 @@ - - - - - - - - @@ -48,31 +35,38 @@ - + - - - - - + + + + + + + + + + - - + + - + + - - + + - + + @@ -89,16 +83,6 @@ - - - - - - - - - - @@ -113,50 +97,38 @@ - + - + - + - + - + - - + - - - - - - - - - - - - + + - @@ -169,16 +141,16 @@ - + - + - + From 86eac95046204868a869fcb81a4eff55016a509b Mon Sep 17 00:00:00 2001 From: Jean Sirmai Date: Tue, 7 Dec 2021 19:38:42 +0100 Subject: [PATCH 11/11] =?UTF-8?q?version=200.2.1=20(fl=C3=A8ches=20encod?= =?UTF-8?q?=C3=A9es=20sans=20redondance)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- models/dimers random walk.xml | 60 +++++++------- models/testing.xml | 83 +++++++++++++++++++ .../{models_0.2.xmls => models_0.2.1.xmls} | 52 +++++++----- 3 files changed, 144 insertions(+), 51 deletions(-) create mode 100644 models/testing.xml rename schemas/{models_0.2.xmls => models_0.2.1.xmls} (77%) diff --git a/models/dimers random walk.xml b/models/dimers random walk.xml index dd1e7a1..7111d1c 100644 --- a/models/dimers random walk.xml +++ b/models/dimers random walk.xml @@ -1,5 +1,5 @@ - + Modèle de test @@ -26,15 +26,13 @@ - - - - - + + + - + 3 @@ -42,27 +40,27 @@ - + - - + + - + - + - - - - - - - + + + + + + + @@ -76,16 +74,16 @@ - - + + - + - + @@ -97,20 +95,20 @@ - - - - + + + + - - - - + + + + diff --git a/models/testing.xml b/models/testing.xml new file mode 100644 index 0000000..2a30294 --- /dev/null +++ b/models/testing.xml @@ -0,0 +1,83 @@ + + + + Modèle de test + Gaston Lagaffe + 2 + 1629830000 + 1.0 + Ref + + + + + 0 + 9 + + + + + + + + + + + + + + + 3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/schemas/models_0.2.xmls b/schemas/models_0.2.1.xmls similarity index 77% rename from schemas/models_0.2.xmls rename to schemas/models_0.2.1.xmls index f106f88..b58a130 100644 --- a/schemas/models_0.2.xmls +++ b/schemas/models_0.2.1.xmls @@ -14,6 +14,13 @@ + + + + + + + @@ -35,40 +42,45 @@ - - - - - - - - - - + + + + + + + - - - - - + + + + + + + + + - - - - - + + + + + + + + +