diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..0229124 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,35 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # You can also specify other tool versions: + # nodejs: "19" + # rust: "1.64" + # golang: "1.19" + jobs: + post_install: + - pip install .[docs] + +# Build documentation in the "docs/" directory with Sphinx +mkdocs: + configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF and ePub +formats: + - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt \ No newline at end of file diff --git a/README.md b/README.md index 7185bd7..981f125 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,49 @@ + + # circumplex - A Python port of the R Circumplex package + +[![PyPI version](https://badge.fury.io/py/circumplex.svg)](https://badge.fury.io/py/circumplex) +[![Documentation Status](https://readthedocs.org/projects/circumplex/badge/?version=latest)](https://circumplex.readthedocs.io/en/latest/?badge=latest) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) + +_circumplex_ is a Python package for analyzing and visualizing circumplex data. It provides a set of tools for analyzing and visualizing circumplex data, following the Structural Summary Method. This project is a Python implementation based on the R [circumplex](https://circumplex.jmgirard.com/) package. Our goal is to provide a similar functionality and experience for Python users. + +!!! note + This project is still under development. We're working hard to make it as good as possible, but there may be bugs or missing features. If you find any issues, please let us know by submitting an issue on Github. + +## Getting Started + +To get started with _circumplex_, you'll need to install it first. You can do this by running the following command: + +```bash +pip install circumplex +``` + +## Documentation + +This documentation is designed to help you understand and use _circumplex_ effectively. It's divided into several sections: + +- **Tutorials**: Practical examples showing how to use our project in real-world scenarios. +- **API Reference**: Detailed information about our project's API. +- **Contribute**: Information on how you can contribute to our project. + +## Contributing + +We welcome contributions from the community. If you're interested in contributing, please get in touch or submit an issue on Github. + +## License + +This project is licensed under the GNU GPLv3 License. For more information, please see the `license.md` file. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + about.md # The about page. + license.md # The license page. + tutorials/ # Tutorial pages. + Introduction to SSM Analysis.ipynb + ... # Other markdown pages, images and other files. + src/circumplex/ + circumplex.py \ No newline at end of file diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 0000000..95234db --- /dev/null +++ b/docs/about.md @@ -0,0 +1,39 @@ +# Recepto nimios non cupidine secus oscula timuere + +## Ora boumque armorum vicit quae Athamas est + +Lorem markdownum silva at habendum en **tristis nasci ereptaque** Romane te +fuerit raucos **gelidus**. Levi caput superant ab facto; ac protinus avium +latebris Thybrin, Solis et. + +1. Hostilia illic thalamique avido sepulcro socerum retia +2. Quaerunt medias Aesone quas +3. Iamque fuit et quoque protegat +4. Est vocibus + +Villae intervenit recipit cruentatus vagas secretasque Cyllenius nec sinuantur +Glauci, Thaumantidos? Curru cadunt tenebat obsessum, iuga **fortuna exspes**! + +## Nisi duo et titubat mihi tantum non + +Saepe abstrahor Periphanta quid negabat tulit naturaeque quae, [hic +sine](http://iam.org/)! Iove mira fluxit credensque virtus, posuitque; adfore +merces est praesens ergo, Arcas, sucus. Ad [silvae tandem +exorata](http://agro-hoc.org/); silva hirsutus fuit Vulcanum de possit Titan +ulciscere verus quamquam navigat quibus; pes genitor! + +1. Nato tamen et humana et admoneo videtur +2. Tenebant insignia +3. Lucifer penetralia ut illis bimembres saturata membra + +Victus illis! Trepidoque quid habitata, suco esse **Sibyllae** loco superata +comitantibus illa vectus regionibus idonea arbore dextra **non** ferrum. + + var newbie_pup_jumper = metafile_bank(addGateway, mipsScrollWhite.affiliate( + fifoBatchClean)); + net(system, 5 - 1, cluster_icf_heap); + scrapingActiveBit.copyright = bookmark; + var drive_tutorial = frameworkSql; + +Et Themis uterque temptat et crimen adhibere vestem? Deus mens est pulverulenta +*fretum* nimios pharetras suspiria alti Phrygiae potest? diff --git a/docs/img/Circumplex-favi.png b/docs/img/Circumplex-favi.png new file mode 100644 index 0000000..7655c21 Binary files /dev/null and b/docs/img/Circumplex-favi.png differ diff --git a/docs/img/favicon.ico b/docs/img/favicon.ico new file mode 100644 index 0000000..faa5b32 Binary files /dev/null and b/docs/img/favicon.ico differ diff --git a/docs/img/logo-dark.png b/docs/img/logo-dark.png new file mode 100644 index 0000000..ebe2652 Binary files /dev/null and b/docs/img/logo-dark.png differ diff --git a/docs/img/logo-light.png b/docs/img/logo-light.png new file mode 100644 index 0000000..2604a0b Binary files /dev/null and b/docs/img/logo-light.png differ diff --git a/docs/img/small-logo.png b/docs/img/small-logo.png new file mode 100644 index 0000000..911662c Binary files /dev/null and b/docs/img/small-logo.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..efcc831 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,50 @@ +![Image title](img/logo-light.png#only-light) +![Image title](img/logo-dark.png#only-dark) + +# Welcome to Circumplex + +[![PyPI version](https://badge.fury.io/py/circumplex.svg)](https://badge.fury.io/py/circumplex) +[![Documentation Status](https://readthedocs.org/projects/circumplex/badge/?version=latest)](https://circumplex.readthedocs.io/en/latest/?badge=latest) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) + +_circumplex_ is a Python package for analyzing and visualizing circumplex data. It provides a set of tools for analyzing and visualizing circumplex data, following the Structural Summary Method. This project is a Python implementation based on the R [circumplex](https://circumplex.jmgirard.com/) package. Our goal is to provide a similar functionality and experience for Python users. + +!!! note + This project is still under development. We're working hard to make it as good as possible, but there may be bugs or missing features. If you find any issues, please let us know by submitting an issue on Github. + +## Getting Started + +To get started with _circumplex_, you'll need to install it first. You can do this by running the following command: + +```bash +pip install circumplex +``` + +## Documentation + +This documentation is designed to help you understand and use _circumplex_ effectively. It's divided into several sections: + +- **Tutorials**: Practical examples showing how to use our project in real-world scenarios. +- **API Reference**: Detailed information about our project's API. +- **Contribute**: Information on how you can contribute to our project. + +## Contributing + +We welcome contributions from the community. If you're interested in contributing, please get in touch or submit an issue on Github. + +## License + +This project is licensed under the GNU GPLv3 License. For more information, please see the `license.md` file. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + about.md # The about page. + license.md # The license page. + tutorials/ # Tutorial pages. + Introduction to SSM Analysis.ipynb + ... # Other markdown pages, images and other files. + src/circumplex/ + circumplex.py diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000..85c7c69 --- /dev/null +++ b/docs/license.md @@ -0,0 +1,636 @@ +# GNU GENERAL PUBLIC LICENSE +Version 3, 29 June 2007 + +Copyright (C) 2007 [Free Software Foundation, Inc.](http://fsf.org/) + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for software and +other kinds of works. + +The licenses for most software and other practical works are designed to take +away your freedom to share and change the works. By contrast, the GNU General +Public License is intended to guarantee your freedom to share and change all +versions of a program--to make sure it remains free software for all its users. +We, the Free Software Foundation, use the GNU General Public License for most +of our software; it applies also to any other work released this way by its +authors. You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom to +distribute copies of free software (and charge for them if you wish), that you +receive source code or can get it if you want it, that you can change the +software or use pieces of it in new free programs, and that you know you can do +these things. + +To protect your rights, we need to prevent others from denying you these rights +or asking you to surrender the rights. Therefore, you have certain +responsibilities if you distribute copies of the software, or if you modify it: +responsibilities to respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or for +a fee, you must pass on to the recipients the same freedoms that you received. +You must make sure that they, too, receive or can get the source code. And you +must show them these terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: + + 1. assert copyright on the software, and + 2. offer you this License giving you legal permission to copy, distribute + and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that +there is no warranty for this free software. For both users' and authors' sake, +the GPL requires that modified versions be marked as changed, so that their +problems will not be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified +versions of the software inside them, although the manufacturer can do so. This +is fundamentally incompatible with the aim of protecting users' freedom to +change the software. The systematic pattern of such abuse occurs in the area of +products for individuals to use, which is precisely where it is most +unacceptable. Therefore, we have designed this version of the GPL to prohibit +the practice for those products. If such problems arise substantially in other +domains, we stand ready to extend this provision to those domains in future +versions of the GPL, as needed to protect the freedom of users. + +Finally, every program is threatened constantly by software patents. States +should not allow patents to restrict development and use of software on +general-purpose computers, but in those that do, we wish to avoid the special +danger that patents applied to a free program could make it effectively +proprietary. To prevent this, the GPL assures that patents cannot be used to +render the program non-free. + +The precise terms and conditions for copying, distribution and modification +follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +*This License* refers to version 3 of the GNU General Public License. + +*Copyright* also means copyright-like laws that apply to other kinds of works, +such as semiconductor masks. + +*The Program* refers to any copyrightable work licensed under this License. +Each licensee is addressed as *you*. *Licensees* and *recipients* may be +individuals or organizations. + +To *modify* a work means to copy from or adapt all or part of the work in a +fashion requiring copyright permission, other than the making of an exact copy. +The resulting work is called a *modified version* of the earlier work or a work +*based on* the earlier work. + +A *covered work* means either the unmodified Program or a work based on the +Program. + +To *propagate* a work means to do anything with it that, without permission, +would make you directly or secondarily liable for infringement under applicable +copyright law, except executing it on a computer or modifying a private copy. +Propagation includes copying, distribution (with or without modification), +making available to the public, and in some countries other activities as well. + +To *convey* a work means any kind of propagation that enables other parties to +make or receive copies. Mere interaction with a user through a computer +network, with no transfer of a copy, is not conveying. + +An interactive user interface displays *Appropriate Legal Notices* to the +extent that it includes a convenient and prominently visible feature that + + 1. displays an appropriate copyright notice, and + 2. tells the user that there is no warranty for the work (except to the + extent that warranties are provided), that licensees may convey the work + under this License, and how to view a copy of this License. + +If the interface presents a list of user commands or options, such as a menu, a +prominent item in the list meets this criterion. + +### 1. Source Code. + +The *source code* for a work means the preferred form of the work for making +modifications to it. *Object code* means any non-source form of a work. + +A *Standard Interface* means an interface that either is an official standard +defined by a recognized standards body, or, in the case of interfaces specified +for a particular programming language, one that is widely used among developers +working in that language. + +The *System Libraries* of an executable work include anything, other than the +work as a whole, that (a) is included in the normal form of packaging a Major +Component, but which is not part of that Major Component, and (b) serves only +to enable use of the work with that Major Component, or to implement a Standard +Interface for which an implementation is available to the public in source code +form. A *Major Component*, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system (if any) on +which the executable work runs, or a compiler used to produce the work, or an +object code interpreter used to run it. + +The *Corresponding Source* for a work in object code form means all the source +code needed to generate, install, and (for an executable work) run the object +code and to modify the work, including scripts to control those activities. +However, it does not include the work's System Libraries, or general-purpose +tools or generally available free programs which are used unmodified in +performing those activities but which are not part of the work. For example, +Corresponding Source includes interface definition files associated with source +files for the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, such as +by intimate data communication or control flow between those subprograms and +other parts of the work. + +The Corresponding Source need not include anything that users can regenerate +automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of copyright on +the Program, and are irrevocable provided the stated conditions are met. This +License explicitly affirms your unlimited permission to run the unmodified +Program. The output from running a covered work is covered by this License only +if the output, given its content, constitutes a covered work. This License +acknowledges your rights of fair use or other equivalent, as provided by +copyright law. + +You may make, run and propagate covered works that you do not convey, without +conditions so long as your license otherwise remains in force. You may convey +covered works to others for the sole purpose of having them make modifications +exclusively for you, or provide you with facilities for running those works, +provided that you comply with the terms of this License in conveying all +material for which you do not control copyright. Those thus making or running +the covered works for you must do so exclusively on your behalf, under your +direction and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes it +unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological measure +under any applicable law fulfilling obligations under article 11 of the WIPO +copyright treaty adopted on 20 December 1996, or similar laws prohibiting or +restricting circumvention of such measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention is +effected by exercising rights under this License with respect to the covered +work, and you disclaim any intention to limit operation or modification of the +work as a means of enforcing, against the work's users, your or third parties' +legal rights to forbid circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you receive it, +in any medium, provided that you conspicuously and appropriately publish on +each copy an appropriate copyright notice; keep intact all notices stating that +this License and any non-permissive terms added in accord with section 7 apply +to the code; keep intact all notices of the absence of any warranty; and give +all recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you may +offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to produce it +from the Program, in the form of source code under the terms of section 4, +provided that you also meet all of these conditions: + + - a) The work must carry prominent notices stating that you modified it, and + giving a relevant date. + - b) The work must carry prominent notices stating that it is released under + this License and any conditions added under section 7. This requirement + modifies the requirement in section 4 to *keep intact all notices*. + - c) You must license the entire work, as a whole, under this License to + anyone who comes into possession of a copy. This License will therefore + apply, along with any applicable section 7 additional terms, to the whole + of the work, and all its parts, regardless of how they are packaged. This + License gives no permission to license the work in any other way, but it + does not invalidate such permission if you have separately received it. + - d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your work need + not make them do so. + +A compilation of a covered work with other separate and independent works, +which are not by their nature extensions of the covered work, and which are not +combined with it such as to form a larger program, in or on a volume of a +storage or distribution medium, is called an *aggregate* if the compilation and +its resulting copyright are not used to limit the access or legal rights of the +compilation's users beyond what the individual works permit. Inclusion of a +covered work in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of sections 4 +and 5, provided that you also convey the machine-readable Corresponding Source +under the terms of this License, in one of these ways: + + - a) Convey the object code in, or embodied in, a physical product (including + a physical distribution medium), accompanied by the Corresponding Source + fixed on a durable physical medium customarily used for software + interchange. + - b) Convey the object code in, or embodied in, a physical product (including + a physical distribution medium), accompanied by a written offer, valid for + at least three years and valid for as long as you offer spare parts or + customer support for that product model, to give anyone who possesses the + object code either + 1. a copy of the Corresponding Source for all the software in the product + that is covered by this License, on a durable physical medium + customarily used for software interchange, for a price no more than your + reasonable cost of physically performing this conveying of source, or + 2. access to copy the Corresponding Source from a network server at no + charge. + - c) Convey individual copies of the object code with a copy of the written + offer to provide the Corresponding Source. This alternative is allowed only + occasionally and noncommercially, and only if you received the object code + with such an offer, in accord with subsection 6b. + - d) Convey the object code by offering access from a designated place + (gratis or for a charge), and offer equivalent access to the Corresponding + Source in the same way through the same place at no further charge. You + need not require recipients to copy the Corresponding Source along with the + object code. If the place to copy the object code is a network server, the + Corresponding Source may be on a different server operated by you or a + third party) that supports equivalent copying facilities, provided you + maintain clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the Corresponding + Source, you remain obligated to ensure that it is available for as long as + needed to satisfy these requirements. + - e) Convey the object code using peer-to-peer transmission, provided you + inform other peers where the object code and Corresponding Source of the + work are being offered to the general public at no charge under subsection + 6d. + +A separable portion of the object code, whose source code is excluded from the +Corresponding Source as a System Library, need not be included in conveying the +object code work. + +A *User Product* is either + + 1. a *consumer product*, which means any tangible personal property which is + normally used for personal, family, or household purposes, or + 2. anything designed or sold for incorporation into a dwelling. + +In determining whether a product is a consumer product, doubtful cases shall be +resolved in favor of coverage. For a particular product received by a +particular user, *normally used* refers to a typical or common use of that +class of product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected to use, +the product. A product is a consumer product regardless of whether the product +has substantial commercial, industrial or non-consumer uses, unless such uses +represent the only significant mode of use of the product. + +*Installation Information* for a User Product means any methods, procedures, +authorization keys, or other information required to install and execute +modified versions of a covered work in that User Product from a modified +version of its Corresponding Source. The information must suffice to ensure +that the continued functioning of the modified object code is in no case +prevented or interfered with solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as part of a +transaction in which the right of possession and use of the User Product is +transferred to the recipient in perpetuity or for a fixed term (regardless of +how the transaction is characterized), the Corresponding Source conveyed under +this section must be accompanied by the Installation Information. But this +requirement does not apply if neither you nor any third party retains the +ability to install modified object code on the User Product (for example, the +work has been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates for a +work that has been modified or installed by the recipient, or for the User +Product in which it has been modified or installed. Access to a network may be +denied when the modification itself materially and adversely affects the +operation of the network or violates the rules and protocols for communication +across the network. + +Corresponding Source conveyed, and Installation Information provided, in accord +with this section must be in a format that is publicly documented (and with an +implementation available to the public in source code form), and must require +no special password or key for unpacking, reading or copying. + +### 7. Additional Terms. + +*Additional permissions* are terms that supplement the terms of this License by +making exceptions from one or more of its conditions. Additional permissions +that are applicable to the entire Program shall be treated as though they were +included in this License, to the extent that they are valid under applicable +law. If additional permissions apply only to part of the Program, that part may +be used separately under those permissions, but the entire Program remains +governed by this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any +additional permissions from that copy, or from any part of it. (Additional +permissions may be written to require their own removal in certain cases when +you modify the work.) You may place additional permissions on material, added +by you to a covered work, for which you have or can give appropriate copyright +permission. + +Notwithstanding any other provision of this License, for material you add to a +covered work, you may (if authorized by the copyright holders of that material) +supplement the terms of this License with terms: + + - a) Disclaiming warranty or limiting liability differently from the terms of + sections 15 and 16 of this License; or + - b) Requiring preservation of specified reasonable legal notices or author + attributions in that material or in the Appropriate Legal Notices displayed + by works containing it; or + - c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in reasonable + ways as different from the original version; or + - d) Limiting the use for publicity purposes of names of licensors or authors + of the material; or + - e) Declining to grant rights under trademark law for use of some trade + names, trademarks, or service marks; or + - f) Requiring indemnification of licensors and authors of that material by + anyone who conveys the material (or modified versions of it) with + contractual assumptions of liability to the recipient, for any liability + that these contractual assumptions directly impose on those licensors and + authors. + +All other non-permissive additional terms are considered *further restrictions* +within the meaning of section 10. If the Program as you received it, or any +part of it, contains a notice stating that it is governed by this License along +with a term that is a further restriction, you may remove that term. If a +license document contains a further restriction but permits relicensing or +conveying under this License, you may add to a covered work material governed +by the terms of that license document, provided that the further restriction +does not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, +in the relevant source files, a statement of the additional terms that apply to +those files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form of a +separately written license, or stated as exceptions; the above requirements +apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly provided +under this License. Any attempt otherwise to propagate or modify it is void, +and will automatically terminate your rights under this License (including any +patent licenses granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from a +particular copyright holder is reinstated + + - a) provisionally, unless and until the copyright holder explicitly and + finally terminates your license, and + - b) permanently, if the copyright holder fails to notify you of the + violation by some reasonable means prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated +permanently if the copyright holder notifies you of the violation by some +reasonable means, this is the first time you have received notice of violation +of this License (for any work) from that copyright holder, and you cure the +violation prior to 30 days after your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses +of parties who have received copies or rights from you under this License. If +your rights have been terminated and not permanently reinstated, you do not +qualify to receive new licenses for the same material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run a copy +of the Program. Ancillary propagation of a covered work occurring solely as a +consequence of using peer-to-peer transmission to receive a copy likewise does +not require acceptance. However, nothing other than this License grants you +permission to propagate or modify any covered work. These actions infringe +copyright if you do not accept this License. Therefore, by modifying or +propagating a covered work, you indicate your acceptance of this License to do +so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically receives a +license from the original licensors, to run, modify and propagate that work, +subject to this License. You are not responsible for enforcing compliance by +third parties with this License. + +An *entity transaction* is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered work +results from an entity transaction, each party to that transaction who receives +a copy of the work also receives whatever licenses to the work the party's +predecessor in interest had or could give under the previous paragraph, plus a +right to possession of the Corresponding Source of the work from the +predecessor in interest, if the predecessor has it or can get it with +reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights +granted or affirmed under this License. For example, you may not impose a +license fee, royalty, or other charge for exercise of rights granted under this +License, and you may not initiate litigation (including a cross-claim or +counterclaim in a lawsuit) alleging that any patent claim is infringed by +making, using, selling, offering for sale, or importing the Program or any +portion of it. + +### 11. Patents. + +A *contributor* is a copyright holder who authorizes use under this License of +the Program or a work on which the Program is based. The work thus licensed is +called the contributor's *contributor version*. + +A contributor's *essential patent claims* are all patent claims owned or +controlled by the contributor, whether already acquired or hereafter acquired, +that would be infringed by some manner, permitted by this License, of making, +using, or selling its contributor version, but do not include claims that would +be infringed only as a consequence of further modification of the contributor +version. For purposes of this definition, *control* includes the right to grant +patent sublicenses in a manner consistent with the requirements of this +License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent +license under the contributor's essential patent claims, to make, use, sell, +offer for sale, import and otherwise run, modify and propagate the contents of +its contributor version. + +In the following three paragraphs, a *patent license* is any express agreement +or commitment, however denominated, not to enforce a patent (such as an express +permission to practice a patent or covenant not to sue for patent +infringement). To *grant* such a patent license to a party means to make such +an agreement or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the +Corresponding Source of the work is not available for anyone to copy, free of +charge and under the terms of this License, through a publicly available +network server or other readily accessible means, then you must either + + 1. cause the Corresponding Source to be so available, or + 2. arrange to deprive yourself of the benefit of the patent license for this + particular work, or + 3. arrange, in a manner consistent with the requirements of this License, to + extend the patent license to downstream recipients. + +*Knowingly relying* means you have actual knowledge that, but for the patent +license, your conveying the covered work in a country, or your recipient's use +of the covered work in a country, would infringe one or more identifiable +patents in that country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, you +convey, or propagate by procuring conveyance of, a covered work, and grant a +patent license to some of the parties receiving the covered work authorizing +them to use, propagate, modify or convey a specific copy of the covered work, +then the patent license you grant is automatically extended to all recipients +of the covered work and works based on it. + +A patent license is *discriminatory* if it does not include within the scope of +its coverage, prohibits the exercise of, or is conditioned on the non-exercise +of one or more of the rights that are specifically granted under this License. +You may not convey a covered work if you are a party to an arrangement with a +third party that is in the business of distributing software, under which you +make payment to the third party based on the extent of your activity of +conveying the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory patent +license + + - a) in connection with copies of the covered work conveyed by you (or copies + made from those copies), or + - b) primarily for and in connection with specific products or compilations + that contain the covered work, unless you entered into that arrangement, or + that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied +license or other defenses to infringement that may otherwise be available to +you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not excuse +you from the conditions of this License. If you cannot convey a covered work so +as to satisfy simultaneously your obligations under this License and any other +pertinent obligations, then as a consequence you may not convey it at all. For +example, if you agree to terms that obligate you to collect a royalty for +further conveying from those to whom you convey the Program, the only way you +could satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have permission to +link or combine any covered work with a work licensed under version 3 of the +GNU Affero General Public License into a single combined work, and to convey +the resulting work. The terms of this License will continue to apply to the +part which is the covered work, but the special requirements of the GNU Affero +General Public License, section 13, concerning interaction through a network +will apply to the combination as such. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions of the GNU +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems +or concerns. + +Each version is given a distinguishing version number. If the Program specifies +that a certain numbered version of the GNU General Public License *or any later +version* applies to it, you have the option of following the terms and +conditions either of that numbered version or of any later version published by +the Free Software Foundation. If the Program does not specify a version number +of the GNU General Public License, you may choose any version ever published by +the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions of the +GNU General Public License can be used, that proxy's public statement of +acceptance of a version permanently authorizes you to choose that version for +the Program. + +Later license versions may give you additional or different permissions. +However, no additional obligations are imposed on any author or copyright +holder as a result of your choosing to follow a later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE +LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER +PARTIES PROVIDE THE PROGRAM *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER +EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE +QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY +COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS +PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, +INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE +THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED +INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE +PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY +HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided above cannot +be given local legal effect according to their terms, reviewing courts shall +apply local law that most closely approximates an absolute waiver of all civil +liability in connection with the Program, unless a warranty or assumption of +liability accompanies a copy of the Program in return for a fee. + +## END OF TERMS AND CONDITIONS ### + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively state the exclusion +of warranty; and each file should have at least the *copyright* line and a +pointer to where the full notice is found. + + + 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 +[http://www.gnu.org/licenses/](http://www.gnu.org/licenses/). + +The GNU General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may consider +it more useful to permit linking proprietary applications with the library. If +this is what you want to do, use the GNU Lesser General Public License instead +of this License. But first, please read +[http://www.gnu.org/philosophy/why-not-lgpl.html](http://www.gnu.org/philosophy/why-not-lgpl.html). diff --git a/docs/news.md b/docs/news.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/api.md b/docs/reference/api.md new file mode 100644 index 0000000..bf1412b --- /dev/null +++ b/docs/reference/api.md @@ -0,0 +1,11 @@ +# Core functions + +::: circumplex.circumplex + options: + members: + - ssm_analyse + - ssm_parameters + - profile_plot + + + diff --git a/docs/reference/classes.md b/docs/reference/classes.md new file mode 100644 index 0000000..29c3f1a --- /dev/null +++ b/docs/reference/classes.md @@ -0,0 +1,9 @@ +# Dealing with results + +## `SSMParams` + +::: circumplex.circumplex.SSMParams + +## `SSMResults` + +::: circumplex.circumplex.SSMResults \ No newline at end of file diff --git a/docs/reference/utils.md b/docs/reference/utils.md new file mode 100644 index 0000000..a330273 --- /dev/null +++ b/docs/reference/utils.md @@ -0,0 +1,8 @@ +# Utility functions + +::: circumplex.circumplex + options: + filters: + - ssm_analyse + - ssm_parameters + - profile_plot \ No newline at end of file diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..6de7546 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,27 @@ +/* Dark mode */ +[data-md-color-scheme="slate"] { + --md-default-bg-color: #010e20; + --md-accent-color: #71e5e9; +} + +/* This will only apply if the user has chosen a light color scheme */ +@media (prefers-color-scheme: light) { + .only-dark { + display: none; + } + .only-light { + display: block; + margin: auto; + } +} + +/* This will only apply if the user has chosen a dark color scheme */ +@media (prefers-color-scheme: dark) { + .only-light { + display: none; + } + .only-dark { + display: block; + margin: auto; + } +} \ No newline at end of file diff --git a/docs/Introduction to SSM Analysis.ipynb b/docs/tutorials/Intro_to_SSM_Analysis.ipynb similarity index 77% rename from docs/Introduction to SSM Analysis.ipynb rename to docs/tutorials/Intro_to_SSM_Analysis.ipynb index d8f37b4..c6e4f74 100644 --- a/docs/Introduction to SSM Analysis.ipynb +++ b/docs/tutorials/Intro_to_SSM_Analysis.ipynb @@ -14,13 +14,13 @@ }, { "cell_type": "code", - "execution_count": 20, + "execution_count": 31, "id": "initial_id", "metadata": { "collapsed": true, "ExecuteTime": { - "end_time": "2023-11-13T16:59:48.561519Z", - "start_time": "2023-11-13T16:59:48.559895Z" + "end_time": "2023-11-14T17:48:46.479051Z", + "start_time": "2023-11-14T17:48:46.476733Z" } }, "outputs": [], @@ -49,7 +49,7 @@ }, { "cell_type": "code", - "execution_count": 30, + "execution_count": 32, "outputs": [ { "data": { @@ -86,8 +86,8 @@ "metadata": { "collapsed": false, "ExecuteTime": { - "end_time": "2023-11-13T17:02:59.612742Z", - "start_time": "2023-11-13T17:02:59.531538Z" + "end_time": "2023-11-14T17:48:46.568782Z", + "start_time": "2023-11-14T17:48:46.480195Z" } }, "id": "b2b2c99827c47a27" @@ -106,13 +106,26 @@ }, { "cell_type": "code", - "execution_count": null, - "outputs": [], + "execution_count": 33, + "outputs": [ + { + "data": { + "text/plain": "
", + "image/png": "iVBORw0KGgoAAAANSUhEUgAAAg8AAAFlCAYAAABsogsDAAAAOXRFWHRTb2Z0d2FyZQBNYXRwbG90bGliIHZlcnNpb24zLjguMSwgaHR0cHM6Ly9tYXRwbG90bGliLm9yZy/SrBM8AAAACXBIWXMAAA9hAAAPYQGoP6dpAAAarElEQVR4nO3db2zV5f3/8Vdb6ClGWnBdT0t3tAPnX5RiK11BYlzObCKp48ZiJ4Z2DeDUzignm1CBVkQpc0qaSLERdXhDV5wBYqSpuk5ilC7EQhOdgMGi7YznQOc4hxVtoef63fDn8VtbsO/anlJ8PpJzo5fX53yuc9lwnvmc03MSnHNOAAAAQ5Q41gsAAADjC/EAAABMiAcAAGBCPAAAABPiAQAAmBAPAADAhHgAAAAmxAMAADAhHgAAgAnxAAAATMzx8NZbb6m4uFjTpk1TQkKCdu7c+Z3H7N69W9ddd508Ho8uvfRSbd26dRhLBQAA5wJzPHR3d2vWrFmqq6sb0vwjR45owYIFuummm9TW1qb7779fS5cu1WuvvWZeLAAAGHsJ3+eLsRISErRjxw4tXLjwjHNWrFihXbt26f3334+N/eY3v9Hx48fV1NQ03FMDAIAxMmG0T9DS0iK/399vrKioSPfff/8Zj+np6VFPT0/s52g0qs8//1w/+tGPlJCQMFpLBQDgvOOc04kTJzRt2jQlJo7MWx1HPR6CwaC8Xm+/Ma/Xq0gkoi+++EKTJk0acExNTY3Wrl072ksDAOAHo7OzUz/5yU9G5L5GPR6Go7KyUoFAIPZzOBzWxRdfrM7OTqWmpo7hygAAGF8ikYh8Pp8mT548Yvc56vGQmZmpUCjUbywUCik1NXXQqw6S5PF45PF4BoynpqYSDwAADMNIvuw/6p/zUFhYqObm5n5jb7zxhgoLC0f71AAAYBSY4+F///uf2tra1NbWJumrP8Vsa2tTR0eHpK9ecigtLY3Nv+uuu9Te3q4HHnhABw8e1ObNm/XSSy9p+fLlI/MIAABAXJnj4d1339Xs2bM1e/ZsSVIgENDs2bNVVVUlSfrss89iISFJP/3pT7Vr1y698cYbmjVrlp544gk988wzKioqGqGHAAAA4ul7fc5DvEQiEaWlpSkcDvOeBwAADEbjOZTvtgAAACbEAwAAMCEeAACACfEAAABMiAcAAGBCPAAAABPiAQAAmBAPAADAhHgAAAAmxAMAADAhHgAAgAnxAAAATIgHAABgQjwAAAAT4gEAAJgQDwAAwIR4AAAAJsQDAAAwIR4AAIAJ8QAAAEyIBwAAYEI8AAAAE+IBAACYEA8AAMCEeAAAACbEAwAAMCEeAACACfEAAABMiAcAAGBCPAAAABPiAQAAmBAPAADAhHgAAAAmxAMAADAhHgAAgAnxAAAATIgHAABgQjwAAAAT4gEAAJgQDwAAwIR4AAAAJsQDAAAwIR4AAIAJ8QAAAEyIBwAAYEI8AAAAE+IBAACYEA8AAMCEeAAAACbEAwAAMCEeAACAybDioa6uTjk5OUpJSVFBQYH27t171vm1tbW6/PLLNWnSJPl8Pi1fvlxffvnlsBYMAADGljketm3bpkAgoOrqau3bt0+zZs1SUVGRjh49Ouj8F198UStXrlR1dbUOHDigZ599Vtu2bdODDz74vRcPAADizxwPGzdu1LJly1ReXq6rrrpK9fX1uuCCC/Tcc88NOn/Pnj2aN2+eFi1apJycHN188826/fbbv/NqBQAAODeZ4qG3t1etra3y+/3f3EFiovx+v1paWgY9Zu7cuWptbY3FQnt7uxobG3XLLbec8Tw9PT2KRCL9bgAA4NwwwTK5q6tLfX198nq9/ca9Xq8OHjw46DGLFi1SV1eXbrjhBjnndPr0ad11111nfdmipqZGa9eutSwNAADEyaj/tcXu3bu1fv16bd68Wfv27dP27du1a9curVu37ozHVFZWKhwOx26dnZ2jvUwAADBEpisP6enpSkpKUigU6jceCoWUmZk56DFr1qzR4sWLtXTpUknSNddco+7ubt15551atWqVEhMH9ovH45HH47EsDQAAxInpykNycrLy8vLU3NwcG4tGo2publZhYeGgx5w8eXJAICQlJUmSnHPW9QIAgDFmuvIgSYFAQGVlZcrPz9ecOXNUW1ur7u5ulZeXS5JKS0uVnZ2tmpoaSVJxcbE2btyo2bNnq6CgQIcPH9aaNWtUXFwciwgAADB+mOOhpKREx44dU1VVlYLBoHJzc9XU1BR7E2VHR0e/Kw2rV69WQkKCVq9erU8//VQ//vGPVVxcrEcffXTkHgUAAIibBDcOXjuIRCJKS0tTOBxWamrqWC8HAIBxYzSeQ/luCwAAYEI8AAAAE+IBAACYEA8AAMCEeAAAACbEAwAAMCEeAACACfEAAABMiAcAAGBCPAAAABPiAQAAmBAPAADAhHgAAAAmxAMAADAhHgAAgAnxAAAATIgHAABgQjwAAAAT4gEAAJgQDwAAwIR4AAAAJsQDAAAwIR4AAIAJ8QAAAEyIBwAAYEI8AAAAE+IBAACYEA8AAMCEeAAAACbEAwAAMCEeAACACfEAAABMiAcAAGBCPAAAABPiAQAAmBAPAADAhHgAAAAmxAMAADAhHgAAgAnxAAAATIgHAABgQjwAAAAT4gEAAJgQDwAAwIR4AAAAJsQDAAAwIR4AAIAJ8QAAAEyIBwAAYEI8AAAAk2HFQ11dnXJycpSSkqKCggLt3bv3rPOPHz+uiooKZWVlyePx6LLLLlNjY+OwFgwAAMbWBOsB27ZtUyAQUH19vQoKClRbW6uioiIdOnRIGRkZA+b39vbql7/8pTIyMvTyyy8rOztbn3zyiaZMmTIS6wcAAHGW4JxzlgMKCgp0/fXXa9OmTZKkaDQqn8+ne++9VytXrhwwv76+Xn/+85918OBBTZw4cViLjEQiSktLUzgcVmpq6rDuAwCAH6LReA41vWzR29ur1tZW+f3+b+4gMVF+v18tLS2DHvPKK6+osLBQFRUV8nq9mjlzptavX6++vr4znqenp0eRSKTfDQAAnBtM8dDV1aW+vj55vd5+416vV8FgcNBj2tvb9fLLL6uvr0+NjY1as2aNnnjiCT3yyCNnPE9NTY3S0tJiN5/PZ1kmAAAYRaP+1xbRaFQZGRl6+umnlZeXp5KSEq1atUr19fVnPKayslLhcDh26+zsHO1lAgCAITK9YTI9PV1JSUkKhUL9xkOhkDIzMwc9JisrSxMnTlRSUlJs7Morr1QwGFRvb6+Sk5MHHOPxeOTxeCxLAwAAcWK68pCcnKy8vDw1NzfHxqLRqJqbm1VYWDjoMfPmzdPhw4cVjUZjYx9++KGysrIGDQcAAHBuM79sEQgEtGXLFj3//PM6cOCA7r77bnV3d6u8vFySVFpaqsrKytj8u+++W59//rnuu+8+ffjhh9q1a5fWr1+vioqKkXsUAAAgbsyf81BSUqJjx46pqqpKwWBQubm5ampqir2JsqOjQ4mJ3zSJz+fTa6+9puXLl+vaa69Vdna27rvvPq1YsWLkHgUAAIgb8+c8jAU+5wEAgOEZ8895AAAAIB4AAIAJ8QAAAEyIBwAAYEI8AAAAE+IBAACYEA8AAMCEeAAAACbEAwAAMCEeAACACfEAAABMiAcAAGBCPAAAABPiAQAAmBAPAADAhHgAAAAmxAMAADAhHgAAgAnxAAAATIgHAABgQjwAAAAT4gEAAJgQDwAAwIR4AAAAJsQDAAAwIR4AAIAJ8QAAAEyIBwAAYEI8AAAAE+IBAACYEA8AAMCEeAAAACbEAwAAMCEeAACACfEAAABMiAcAAGBCPAAAABPiAQAAmBAPAADAhHgAAAAmxAMAADAhHgAAgAnxAAAATIgHAABgQjwAAAAT4gEAAJgQDwAAwIR4AAAAJsQDAAAwIR4AAIAJ8QAAAEyGFQ91dXXKyclRSkqKCgoKtHfv3iEd19DQoISEBC1cuHA4pwUAAOcAczxs27ZNgUBA1dXV2rdvn2bNmqWioiIdPXr0rMd9/PHH+sMf/qD58+cPe7EAAGDsmeNh48aNWrZsmcrLy3XVVVepvr5eF1xwgZ577rkzHtPX16c77rhDa9eu1fTp07/XggEAwNgyxUNvb69aW1vl9/u/uYPERPn9frW0tJzxuIcfflgZGRlasmTJkM7T09OjSCTS7wYAAM4Npnjo6upSX1+fvF5vv3Gv16tgMDjoMW+//baeffZZbdmyZcjnqampUVpaWuzm8/ksywQAAKNoVP/a4sSJE1q8eLG2bNmi9PT0IR9XWVmpcDgcu3V2do7iKgEAgMUEy+T09HQlJSUpFAr1Gw+FQsrMzBww/6OPPtLHH3+s4uLi2Fg0Gv3qxBMm6NChQ5oxY8aA4zwejzwej2VpAAAgTkxXHpKTk5WXl6fm5ubYWDQaVXNzswoLCwfMv+KKK/Tee++pra0tdrv11lt10003qa2tjZcjAAAYh0xXHiQpEAiorKxM+fn5mjNnjmpra9Xd3a3y8nJJUmlpqbKzs1VTU6OUlBTNnDmz3/FTpkyRpAHjAABgfDDHQ0lJiY4dO6aqqioFg0Hl5uaqqakp9ibKjo4OJSbywZUAAJyvEpxzbqwX8V0ikYjS0tIUDoeVmpo61ssBAGDcGI3nUC4RAAAAE+IBAACYEA8AAMCEeAAAACbEAwAAMCEeAACACfEAAABMiAcAAGBCPAAAABPiAQAAmBAPAADAhHgAAAAmxAMAADAhHgAAgAnxAAAATIgHAABgQjwAAAAT4gEAAJgQDwAAwIR4AAAAJsQDAAAwIR4AAIAJ8QAAAEyIBwAAYEI8AAAAE+IBAACYEA8AAMCEeAAAACbEAwAAMCEeAACACfEAAABMiAcAAGBCPAAAABPiAQAAmBAPAADAhHgAAAAmxAMAADAhHgAAgAnxAAAATIgHAABgQjwAAAAT4gEAAJgQDwAAwIR4AAAAJsQDAAAwIR4AAIAJ8QAAAEyIBwAAYEI8AAAAE+IBAACYDCse6urqlJOTo5SUFBUUFGjv3r1nnLtlyxbNnz9fU6dO1dSpU+X3+886HwAAnNvM8bBt2zYFAgFVV1dr3759mjVrloqKinT06NFB5+/evVu333673nzzTbW0tMjn8+nmm2/Wp59++r0XDwAA4i/BOecsBxQUFOj666/Xpk2bJEnRaFQ+n0/33nuvVq5c+Z3H9/X1aerUqdq0aZNKS0uHdM5IJKK0tDSFw2GlpqZalgsAwA/aaDyHmq489Pb2qrW1VX6//5s7SEyU3+9XS0vLkO7j5MmTOnXqlC666CLbSgEAwDlhgmVyV1eX+vr65PV6+417vV4dPHhwSPexYsUKTZs2rV+AfFtPT496enpiP0ciEcsyAQDAKIrrX1ts2LBBDQ0N2rFjh1JSUs44r6amRmlpabGbz+eL4yoBAMDZmOIhPT1dSUlJCoVC/cZDoZAyMzPPeuzjjz+uDRs26PXXX9e111571rmVlZUKh8OxW2dnp2WZAABgFJniITk5WXl5eWpubo6NRaNRNTc3q7Cw8IzHPfbYY1q3bp2ampqUn5//nefxeDxKTU3tdwMAAOcG03seJCkQCKisrEz5+fmaM2eOamtr1d3drfLycklSaWmpsrOzVVNTI0n605/+pKqqKr344ovKyclRMBiUJF144YW68MILR/ChAACAeDDHQ0lJiY4dO6aqqioFg0Hl5uaqqakp9ibKjo4OJSZ+c0HjqaeeUm9vr37961/3u5/q6mo99NBD32/1AAAg7syf8zAW+JwHAACGZ8w/5wEAAIB4AAAAJsQDAAAwIR4AAIAJ8QAAAEyIBwAAYEI8AAAAE+IBAACYEA8AAMCEeAAAACbEAwAAMCEeAACACfEAAABMiAcAAGBCPAAAABPiAQAAmBAPAADAhHgAAAAmxAMAADAhHgAAgAnxAAAATIgHAABgQjwAAAAT4gEAAJgQDwAAwIR4AAAAJsQDAAAwIR4AAIAJ8QAAAEyIBwAAYEI8AAAAE+IBAACYEA8AAMCEeAAAACbEAwAAMCEeAACACfEAAABMiAcAAGBCPAAAABPiAQAAmBAPAADAhHgAAAAmxAMAADAhHgAAgAnxAAAATIgHAABgQjwAAAAT4gEAAJgQDwAAwIR4AAAAJsQDAAAwGVY81NXVKScnRykpKSooKNDevXvPOv9vf/ubrrjiCqWkpOiaa65RY2PjsBYLAADGnjketm3bpkAgoOrqau3bt0+zZs1SUVGRjh49Ouj8PXv26Pbbb9eSJUu0f/9+LVy4UAsXLtT777//vRcPAADiL8E55ywHFBQU6Prrr9emTZskSdFoVD6fT/fee69Wrlw5YH5JSYm6u7v16quvxsZ+/vOfKzc3V/X19UM6ZyQSUVpamsLhsFJTUy3LBQDgB200nkMnWCb39vaqtbVVlZWVsbHExET5/X61tLQMekxLS4sCgUC/saKiIu3cufOM5+np6VFPT0/s53A4LOmrDQAAAEP39XOn8VrBWZnioaurS319ffJ6vf3GvV6vDh48OOgxwWBw0PnBYPCM56mpqdHatWsHjPt8PstyAQDA//ef//xHaWlpI3JfpniIl8rKyn5XK44fP65LLrlEHR0dI/bAcXaRSEQ+n0+dnZ28VBQn7Hn8sefxx57HXzgc1sUXX6yLLrpoxO7TFA/p6elKSkpSKBTqNx4KhZSZmTnoMZmZmab5kuTxeOTxeAaMp6Wl8csWZ6mpqex5nLHn8ceexx97Hn+JiSP36Qyme0pOTlZeXp6am5tjY9FoVM3NzSosLBz0mMLCwn7zJemNN94443wAAHBuM79sEQgEVFZWpvz8fM2ZM0e1tbXq7u5WeXm5JKm0tFTZ2dmqqamRJN1333268cYb9cQTT2jBggVqaGjQu+++q6effnpkHwkAAIgLczyUlJTo2LFjqqqqUjAYVG5urpqammJviuzo6Oh3aWTu3Ll68cUXtXr1aj344IP62c9+pp07d2rmzJlDPqfH41F1dfWgL2VgdLDn8ceexx97Hn/sefyNxp6bP+cBAAD8sPHdFgAAwIR4AAAAJsQDAAAwIR4AAIDJORMPfM13/Fn2fMuWLZo/f76mTp2qqVOnyu/3f+f/Iwxk/T3/WkNDgxISErRw4cLRXeB5yLrnx48fV0VFhbKysuTxeHTZZZfx74uRdc9ra2t1+eWXa9KkSfL5fFq+fLm+/PLLOK12fHvrrbdUXFysadOmKSEh4azfG/W13bt367rrrpPH49Gll16qrVu32k/szgENDQ0uOTnZPffcc+5f//qXW7ZsmZsyZYoLhUKDzn/nnXdcUlKSe+yxx9wHH3zgVq9e7SZOnOjee++9OK98/LLu+aJFi1xdXZ3bv3+/O3DggPvtb3/r0tLS3L///e84r3z8su75144cOeKys7Pd/Pnz3a9+9av4LPY8Yd3znp4el5+f72655Rb39ttvuyNHjrjdu3e7tra2OK98/LLu+QsvvOA8Ho974YUX3JEjR9xrr73msrKy3PLly+O88vGpsbHRrVq1ym3fvt1Jcjt27Djr/Pb2dnfBBRe4QCDgPvjgA/fkk0+6pKQk19TUZDrvOREPc+bMcRUVFbGf+/r63LRp01xNTc2g82+77Ta3YMGCfmMFBQXud7/73aiu83xi3fNvO336tJs8ebJ7/vnnR2uJ553h7Pnp06fd3Llz3TPPPOPKysqIByPrnj/11FNu+vTprre3N15LPO9Y97yiosL94he/6DcWCATcvHnzRnWd56OhxMMDDzzgrr766n5jJSUlrqioyHSuMX/Z4uuv+fb7/bGxoXzN9/+dL331Nd9nmo/+hrPn33by5EmdOnVqRL9o5Xw23D1/+OGHlZGRoSVLlsRjmeeV4ez5K6+8osLCQlVUVMjr9WrmzJlav369+vr64rXscW04ez537ly1trbGXtpob29XY2Ojbrnllris+YdmpJ4/x/xbNeP1Nd/4xnD2/NtWrFihadOmDfglxOCGs+dvv/22nn32WbW1tcVhheef4ex5e3u7/vGPf+iOO+5QY2OjDh8+rHvuuUenTp1SdXV1PJY9rg1nzxctWqSuri7dcMMNcs7p9OnTuuuuu/Tggw/GY8k/OGd6/oxEIvriiy80adKkId3PmF95wPizYcMGNTQ0aMeOHUpJSRnr5ZyXTpw4ocWLF2vLli1KT08f6+X8YESjUWVkZOjpp59WXl6eSkpKtGrVKtXX14/10s5bu3fv1vr167V582bt27dP27dv165du7Ru3bqxXhrOYsyvPMTra77xjeHs+dcef/xxbdiwQX//+9917bXXjuYyzyvWPf/oo4/08ccfq7i4ODYWjUYlSRMmTNChQ4c0Y8aM0V30ODec3/OsrCxNnDhRSUlJsbErr7xSwWBQvb29Sk5OHtU1j3fD2fM1a9Zo8eLFWrp0qSTpmmuuUXd3t+68806tWrVqRL9GGmd+/kxNTR3yVQfpHLjywNd8x99w9lySHnvsMa1bt05NTU3Kz8+Px1LPG9Y9v+KKK/Tee++pra0tdrv11lt10003qa2tTT6fL57LH5eG83s+b948HT58OBZqkvThhx8qKyuLcBiC4ez5yZMnBwTC1/Hm+OqlETdiz5+293KOjoaGBufxeNzWrVvdBx984O688043ZcoUFwwGnXPOLV682K1cuTI2/5133nETJkxwjz/+uDtw4ICrrq7mTzWNrHu+YcMGl5yc7F5++WX32WefxW4nTpwYq4cw7lj3/Nv4aws76553dHS4yZMnu9///vfu0KFD7tVXX3UZGRnukUceGauHMO5Y97y6utpNnjzZ/fWvf3Xt7e3u9ddfdzNmzHC33XbbWD2EceXEiRNu//79bv/+/U6S27hxo9u/f7/75JNPnHPOrVy50i1evDg2/+s/1fzjH//oDhw44Orq6sbvn2o659yTTz7pLr74YpecnOzmzJnj/vnPf8b+24033ujKysr6zX/ppZfcZZdd5pKTk93VV1/tdu3aFecVj3+WPb/kkkucpAG36urq+C98HLP+nv9fxMPwWPd8z549rqCgwHk8Hjd9+nT36KOPutOnT8d51eObZc9PnTrlHnroITdjxgyXkpLifD6fu+eee9x///vf+C98HHrzzTcH/bf56z0uKytzN95444BjcnNzXXJysps+fbr7y1/+Yj4vX8kNAABMxvw9DwAAYHwhHgAAgAnxAAAATIgHAABgQjwAAAAT4gEAAJgQDwAAwIR4AAAAJsQDAAAwIR4AAIAJ8QAAAEyIBwAAYPL/AEUewRo9g27YAAAAAElFTkSuQmCC" + }, + "metadata": {}, + "output_type": "display_data" + } + ], "source": [ "fig, ax = plt.subplots(figsize=(6, 4))\n" ], "metadata": { - "collapsed": false + "collapsed": false, + "ExecuteTime": { + "end_time": "2023-11-14T17:48:46.615165Z", + "start_time": "2023-11-14T17:48:46.571692Z" + } }, "id": "4fca74a7a59559a" } diff --git a/tests/Intro_SSM.ipynb b/docs/tutorials/Random_exs.ipynb similarity index 100% rename from tests/Intro_SSM.ipynb rename to docs/tutorials/Random_exs.ipynb diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md new file mode 100644 index 0000000..2fea9a8 --- /dev/null +++ b/docs/tutorials/index.md @@ -0,0 +1,4 @@ +# Tutorials + +Each of the tutorials provided will walk you through the basic functionality of _circumplex_ as well as the basic concepts of structural summary method analysis. + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..2c51834 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,60 @@ +# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json +site_name: "Circumplex" +site_url: https://circumplex.readthedocs.io/en/latest/ +site_dir: site +repo_name: "MitchellAcoustics/circumplex" +repo_url: https://github.com/MitchellAcoustics/circumplex +copyright: Copyright © 2023 Andrew Mitchell +nav: + - Home: index.md + - About: + - 'License': license.md + - Tutorials: + - tutorials/index.md + - 'Introduction to SSM': tutorials/Intro_to_SSM_Analysis.ipynb + - 'Random Examples': tutorials/Random_exs.ipynb + - 'API reference': + - 'Core functions': reference/api.md + - 'Dealing with results': reference/classes.md + - 'Utils': reference/utils.md + - 'News': news.md +theme: + name: material + logo: img/small-logo.png + favicon: img/favicon.ico + features: + - navigation.tabs + - navigation.expand + - navigation.path + - navigation.top + palette: + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to light mode +extra_css: + - stylesheets/extra.css + +plugins: + - search + - mkdocstrings: + handlers: + python: + options: + docstring_section_style: table + - mkdocs-jupyter: + include_source: true + theme: default +# execute: true + +markdown_extensions: + - admonition \ No newline at end of file diff --git a/pdm.lock b/pdm.lock index 603bec5..5e2915c 100644 --- a/pdm.lock +++ b/pdm.lock @@ -5,24 +5,7 @@ groups = ["default", "test", "docs", "dev"] strategy = ["cross_platform"] lock_version = "4.4" -content_hash = "sha256:8b9b7b8d38c4dd4b19b4637541c07ce02868d45435a2e656e01968dffba3e608" - -[[package]] -name = "acoustics" -version = "0.2.6" -requires_python = ">=3.6" -summary = "Acoustics module for Python." -dependencies = [ - "matplotlib", - "numpy>=1.8", - "pandas>=0.15", - "scipy>=0.16", - "six>=1.4.1", - "tabulate", -] -files = [ - {file = "acoustics-0.2.6.tar.gz", hash = "sha256:d02bcc84251cfa2edd3e21c7f885dd963f8e8c587f975c2f9d4e1d9b142bcc52"}, -] +content_hash = "sha256:d28619aadd3a444b9962be8c1fcde33a248ae6e00302bb2a1914cd752fc6d7d1" [[package]] name = "anyio" @@ -178,24 +161,6 @@ files = [ {file = "bleach-6.1.0.tar.gz", hash = "sha256:0a31f1837963c41d46bbf1331b8778e1308ea0791db03cc4e7357b97cf42a8fe"}, ] -[[package]] -name = "bottleneck" -version = "1.3.7" -summary = "Fast NumPy array functions written in C" -dependencies = [ - "numpy", -] -files = [ - {file = "Bottleneck-1.3.7-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:752c97d64ebebdc10a5568d97b81b4971238fa4b53533248d227c4ea759aee4e"}, - {file = "Bottleneck-1.3.7-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bbda2b27e81a47b7578bce6a8cb2f5eb899279c828d8efb5a154d8ede785093d"}, - {file = "Bottleneck-1.3.7-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:79160e49a5a0438468b970967e29addde2d9c6a6ce930144de7ccd8151077603"}, - {file = "Bottleneck-1.3.7-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:abfc22762640cc7716c1bd9a409bde0f834167a2584775eb644c6afe7bae3319"}, - {file = "Bottleneck-1.3.7-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:2a39049aa1cb798538f96150098f50badb37417c41cecfa8a441c0c4e6433c7e"}, - {file = "Bottleneck-1.3.7-cp311-cp311-win32.whl", hash = "sha256:b624023f173332d209ed5bd4134fae43d2432d61c6b17a49a6b7c5591caa7cc4"}, - {file = "Bottleneck-1.3.7-cp311-cp311-win_amd64.whl", hash = "sha256:bd69b1844c90f6bcf1b679a608fb2c0909be5e045f91674d61a0e4c3596644be"}, - {file = "Bottleneck-1.3.7.tar.gz", hash = "sha256:e1467e373ad469da340ed0ff283214d6531cc08bfdca2083361a3aa6470681f8"}, -] - [[package]] name = "certifi" version = "2023.7.22" @@ -557,6 +522,19 @@ files = [ {file = "ghp_import-2.1.0-py3-none-any.whl", hash = "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619"}, ] +[[package]] +name = "griffe" +version = "0.38.0" +requires_python = ">=3.8" +summary = "Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API." +dependencies = [ + "colorama>=0.4", +] +files = [ + {file = "griffe-0.38.0-py3-none-any.whl", hash = "sha256:6a5bc457320e8e199006aa5fbb03e162f5e21abe31aa6221f7a5c37ea0724c71"}, + {file = "griffe-0.38.0.tar.gz", hash = "sha256:9b97487b583042b543d1e28196caee638ecd766c8c4c98135071806cb5333ac2"}, +] + [[package]] name = "idna" version = "3.4" @@ -567,20 +545,6 @@ files = [ {file = "idna-3.4.tar.gz", hash = "sha256:814f528e8dead7d329833b91c5faa87d60bf71824cd12a7530b5526063d02cb4"}, ] -[[package]] -name = "imageio" -version = "2.32.0" -requires_python = ">=3.8" -summary = "Library for reading and writing a wide range of image, video, scientific, and volumetric data formats." -dependencies = [ - "numpy", - "pillow<10.1.0,>=8.3.2", -] -files = [ - {file = "imageio-2.32.0-py3-none-any.whl", hash = "sha256:70e63a8955fb08242c9cbc4cdc40728ab892f76955b99cc6a0c5f304b4b84970"}, - {file = "imageio-2.32.0.tar.gz", hash = "sha256:e425ad36c605308d9ea6d93eda7b0987926059b8b86220e142a599a7975128dd"}, -] - [[package]] name = "iniconfig" version = "2.0.0" @@ -982,6 +946,23 @@ files = [ {file = "jupyterlab_widgets-3.0.9.tar.gz", hash = "sha256:6005a4e974c7beee84060fdfba341a3218495046de8ae3ec64888e5fe19fdb4c"}, ] +[[package]] +name = "jupytext" +version = "1.15.2" +requires_python = "~=3.6" +summary = "Jupyter notebooks as Markdown documents, Julia, Python or R scripts" +dependencies = [ + "markdown-it-py>=1.0.0", + "mdit-py-plugins", + "nbformat", + "pyyaml", + "toml", +] +files = [ + {file = "jupytext-1.15.2-py3-none-any.whl", hash = "sha256:ef2a1a3eb8f63d84a3b3772014bdfbe238e4e12a30c4309b8c89e0a54adeb7d1"}, + {file = "jupytext-1.15.2.tar.gz", hash = "sha256:c9976e24d834e991906c1de55af4b6d512d764f6372aabae45fc1ea72b589173"}, +] + [[package]] name = "kiwisolver" version = "1.4.5" @@ -1066,30 +1047,6 @@ files = [ {file = "kiwisolver-1.4.5.tar.gz", hash = "sha256:e57e563a57fb22a142da34f38acc2fc1a5c864bc29ca1517a88abc963e60d6ec"}, ] -[[package]] -name = "lazy-loader" -version = "0.3" -requires_python = ">=3.7" -summary = "lazy_loader" -files = [ - {file = "lazy_loader-0.3-py3-none-any.whl", hash = "sha256:1e9e76ee8631e264c62ce10006718e80b2cfc74340d17d1031e0f84af7478554"}, - {file = "lazy_loader-0.3.tar.gz", hash = "sha256:3b68898e34f5b2a29daaaac172c6555512d0f32074f147e2254e4a6d9d838f37"}, -] - -[[package]] -name = "llvmlite" -version = "0.41.1" -requires_python = ">=3.8" -summary = "lightweight wrapper around basic LLVM functionality" -files = [ - {file = "llvmlite-0.41.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:210e458723436b2469d61b54b453474e09e12a94453c97ea3fbb0742ba5a83d8"}, - {file = "llvmlite-0.41.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:855f280e781d49e0640aef4c4af586831ade8f1a6c4df483fb901cbe1a48d127"}, - {file = "llvmlite-0.41.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b67340c62c93a11fae482910dc29163a50dff3dfa88bc874872d28ee604a83be"}, - {file = "llvmlite-0.41.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2181bb63ef3c607e6403813421b46982c3ac6bfc1f11fa16a13eaafb46f578e6"}, - {file = "llvmlite-0.41.1-cp311-cp311-win_amd64.whl", hash = "sha256:9564c19b31a0434f01d2025b06b44c7ed422f51e719ab5d24ff03b7560066c9a"}, - {file = "llvmlite-0.41.1.tar.gz", hash = "sha256:f19f767a018e6ec89608e1f6b13348fa2fcde657151137cb64e56d48598a92db"}, -] - [[package]] name = "markdown" version = "3.5.1" @@ -1100,6 +1057,19 @@ files = [ {file = "Markdown-3.5.1.tar.gz", hash = "sha256:b65d7beb248dc22f2e8a31fb706d93798093c308dc1aba295aedeb9d41a813bd"}, ] +[[package]] +name = "markdown-it-py" +version = "3.0.0" +requires_python = ">=3.8" +summary = "Python port of markdown-it. Markdown parsing, done right!" +dependencies = [ + "mdurl~=0.1", +] +files = [ + {file = "markdown-it-py-3.0.0.tar.gz", hash = "sha256:e3f60a94fa066dc52ec76661e37c851cb232d92f9886b15cb560aaada2df8feb"}, + {file = "markdown_it_py-3.0.0-py3-none-any.whl", hash = "sha256:355216845c60bd96232cd8d8c40e8f9765cc86f46880e43a8fd22dc1a1a8cab1"}, +] + [[package]] name = "markupsafe" version = "2.1.3" @@ -1209,6 +1179,29 @@ files = [ {file = "matplotlib_inline-0.1.6-py3-none-any.whl", hash = "sha256:f1f41aab5328aa5aaea9b16d083b128102f8712542f819fe7e6a420ff581b311"}, ] +[[package]] +name = "mdit-py-plugins" +version = "0.4.0" +requires_python = ">=3.8" +summary = "Collection of plugins for markdown-it-py" +dependencies = [ + "markdown-it-py<4.0.0,>=1.0.0", +] +files = [ + {file = "mdit_py_plugins-0.4.0-py3-none-any.whl", hash = "sha256:b51b3bb70691f57f974e257e367107857a93b36f322a9e6d44ca5bf28ec2def9"}, + {file = "mdit_py_plugins-0.4.0.tar.gz", hash = "sha256:d8ab27e9aed6c38aa716819fedfde15ca275715955f8a185a8e1cf90fb1d2c1b"}, +] + +[[package]] +name = "mdurl" +version = "0.1.2" +requires_python = ">=3.7" +summary = "Markdown URL utilities" +files = [ + {file = "mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8"}, + {file = "mdurl-0.1.2.tar.gz", hash = "sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba"}, +] + [[package]] name = "mergedeep" version = "1.3.4" @@ -1255,16 +1248,115 @@ files = [ ] [[package]] -name = "mosqito" -version = "1.0.8" -requires_python = ">= 3.5" -summary = "Modular Sound Quality Integrated Toolbox" +name = "mkdocs-autorefs" +version = "0.5.0" +requires_python = ">=3.8" +summary = "Automatically link across pages in MkDocs." dependencies = [ - "numpy", - "scipy", + "Markdown>=3.3", + "mkdocs>=1.1", ] files = [ - {file = "mosqito-1.0.8.tar.gz", hash = "sha256:4e723d7538d16488fe14d7ee19d9f9ce2b4f1bad5b59b4c4f7fb3b0610d434a7"}, + {file = "mkdocs_autorefs-0.5.0-py3-none-any.whl", hash = "sha256:7930fcb8ac1249f10e683967aeaddc0af49d90702af111a5e390e8b20b3d97ff"}, + {file = "mkdocs_autorefs-0.5.0.tar.gz", hash = "sha256:9a5054a94c08d28855cfab967ada10ed5be76e2bfad642302a610b252c3274c0"}, +] + +[[package]] +name = "mkdocs-jupyter" +version = "0.24.6" +requires_python = ">=3.9" +summary = "Use Jupyter in mkdocs websites" +dependencies = [ + "ipykernel<7.0.0,>6.0.0", + "jupytext<2,>1.13.8", + "mkdocs-material>9.0.0", + "mkdocs<2,>=1.4.0", + "nbconvert<8,>=7.2.9", + "pygments>2.12.0", +] +files = [ + {file = "mkdocs_jupyter-0.24.6-py3-none-any.whl", hash = "sha256:56fb7ad796f2414a4143d54a966b805caf315c32413e97f85591623fa87dceca"}, + {file = "mkdocs_jupyter-0.24.6.tar.gz", hash = "sha256:89fcbe8a9523864d5416de1a60711640b6bc2972279d2adf46ed2776c2d9ff7c"}, +] + +[[package]] +name = "mkdocs-material" +version = "9.4.8" +requires_python = ">=3.8" +summary = "Documentation that simply works" +dependencies = [ + "babel~=2.10", + "colorama~=0.4", + "jinja2~=3.0", + "markdown~=3.2", + "mkdocs-material-extensions~=1.3", + "mkdocs>=1.5.3,~=1.5", + "paginate~=0.5", + "pygments~=2.16", + "pymdown-extensions~=10.2", + "regex>=2022.4", + "requests~=2.26", +] +files = [ + {file = "mkdocs_material-9.4.8-py3-none-any.whl", hash = "sha256:8b20f6851bddeef37dced903893cd176cf13a21a482e97705a103c45f06ce9b9"}, + {file = "mkdocs_material-9.4.8.tar.gz", hash = "sha256:f0c101453e8bc12b040e8b64ca39a405d950d8402609b1378cc2b98976e74b5f"}, +] + +[[package]] +name = "mkdocs-material-extensions" +version = "1.3" +requires_python = ">=3.8" +summary = "Extension pack for Python Markdown and MkDocs Material." +files = [ + {file = "mkdocs_material_extensions-1.3-py3-none-any.whl", hash = "sha256:0297cc48ba68a9fdd1ef3780a3b41b534b0d0df1d1181a44676fda5f464eeadc"}, + {file = "mkdocs_material_extensions-1.3.tar.gz", hash = "sha256:f0446091503acb110a7cab9349cbc90eeac51b58d1caa92a704a81ca1e24ddbd"}, +] + +[[package]] +name = "mkdocstrings" +version = "0.23.0" +requires_python = ">=3.8" +summary = "Automatic documentation from sources, for MkDocs." +dependencies = [ + "Jinja2>=2.11.1", + "Markdown>=3.3", + "MarkupSafe>=1.1", + "mkdocs-autorefs>=0.3.1", + "mkdocs>=1.2", + "pymdown-extensions>=6.3", +] +files = [ + {file = "mkdocstrings-0.23.0-py3-none-any.whl", hash = "sha256:051fa4014dfcd9ed90254ae91de2dbb4f24e166347dae7be9a997fe16316c65e"}, + {file = "mkdocstrings-0.23.0.tar.gz", hash = "sha256:d9c6a37ffbe7c14a7a54ef1258c70b8d394e6a33a1c80832bce40b9567138d1c"}, +] + +[[package]] +name = "mkdocstrings-python" +version = "1.7.4" +requires_python = ">=3.8" +summary = "A Python handler for mkdocstrings." +dependencies = [ + "griffe>=0.37", + "mkdocstrings>=0.20", +] +files = [ + {file = "mkdocstrings_python-1.7.4-py3-none-any.whl", hash = "sha256:70eacbe5f2d5071f2e525ba0b35bc447d398437dfbcd90c63fe6e977551cfe26"}, + {file = "mkdocstrings_python-1.7.4.tar.gz", hash = "sha256:c2fc34efd70000ec31aee247910006e8dd9d1b9f3957bf46880c3f6e51a8f0d5"}, +] + +[[package]] +name = "mkdocstrings" +version = "0.23.0" +extras = ["python"] +requires_python = ">=3.8" +summary = "Automatic documentation from sources, for MkDocs." +dependencies = [ + "mkdocstrings-python>=0.5.2", + "mkdocstrings==0.23.0", +] +files = [ + {file = "mkdocstrings-0.23.0-py3-none-any.whl", hash = "sha256:051fa4014dfcd9ed90254ae91de2dbb4f24e166347dae7be9a997fe16316c65e"}, + {file = "mkdocstrings-0.23.0.tar.gz", hash = "sha256:d9c6a37ffbe7c14a7a54ef1258c70b8d394e6a33a1c80832bce40b9567138d1c"}, ] [[package]] @@ -1336,16 +1428,6 @@ files = [ {file = "nest_asyncio-1.5.8.tar.gz", hash = "sha256:25aa2ca0d2a5b5531956b9e273b45cf664cae2b145101d73b86b199978d48fdb"}, ] -[[package]] -name = "networkx" -version = "3.2.1" -requires_python = ">=3.9" -summary = "Python package for creating and manipulating graphs and networks" -files = [ - {file = "networkx-3.2.1-py3-none-any.whl", hash = "sha256:f18c69adc97877c42332c170849c96cefa91881c99a7cb3e95b7c659ebdc1ec2"}, - {file = "networkx-3.2.1.tar.gz", hash = "sha256:9f1bb5cf3409bf324e0a722c20bdb4c20ee39bf1c30ce8ae499c8502b0b5e0c6"}, -] - [[package]] name = "notebook" version = "7.0.6" @@ -1376,50 +1458,6 @@ files = [ {file = "notebook_shim-0.2.3.tar.gz", hash = "sha256:f69388ac283ae008cd506dda10d0288b09a017d822d5e8c7129a152cbd3ce7e9"}, ] -[[package]] -name = "numba" -version = "0.58.1" -requires_python = ">=3.8" -summary = "compiling Python code using LLVM" -dependencies = [ - "llvmlite<0.42,>=0.41.0dev0", - "numpy<1.27,>=1.22", -] -files = [ - {file = "numba-0.58.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:bcecd3fb9df36554b342140a4d77d938a549be635d64caf8bd9ef6c47a47f8aa"}, - {file = "numba-0.58.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:a1eaa744f518bbd60e1f7ccddfb8002b3d06bd865b94a5d7eac25028efe0e0ff"}, - {file = "numba-0.58.1-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:bf68df9c307fb0aa81cacd33faccd6e419496fdc621e83f1efce35cdc5e79cac"}, - {file = "numba-0.58.1-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:55a01e1881120e86d54efdff1be08381886fe9f04fc3006af309c602a72bc44d"}, - {file = "numba-0.58.1-cp311-cp311-win_amd64.whl", hash = "sha256:811305d5dc40ae43c3ace5b192c670c358a89a4d2ae4f86d1665003798ea7a1a"}, - {file = "numba-0.58.1.tar.gz", hash = "sha256:487ded0633efccd9ca3a46364b40006dbdaca0f95e99b8b83e778d1195ebcbaa"}, -] - -[[package]] -name = "numexpr" -version = "2.8.7" -requires_python = ">=3.9" -summary = "Fast numerical expression evaluator for NumPy" -dependencies = [ - "numpy>=1.13.3", -] -files = [ - {file = "numexpr-2.8.7-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:32934d51b5bc8a6636436326da79ed380e2f151989968789cf65b1210572cb46"}, - {file = "numexpr-2.8.7-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f021ac93cb3dd5d8ba2882627b615b1f58cb089dcc85764c6fbe7a549ed21b0c"}, - {file = "numexpr-2.8.7-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dccf572763517db6562fb7b17db46aacbbf62a9ca0a66672872f4f71aee7b186"}, - {file = "numexpr-2.8.7-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:11121b14ee3179bade92e823f25f1b94e18716d33845db5081973331188c3338"}, - {file = "numexpr-2.8.7-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:81451962d4145a46dba189df65df101d4d1caddb6efe6ebfe05982cd9f62b2cf"}, - {file = "numexpr-2.8.7-cp311-cp311-win32.whl", hash = "sha256:da55ba845b847cc33c4bf81cee4b1bddfb0831118cabff8db62888ab8697ec34"}, - {file = "numexpr-2.8.7-cp311-cp311-win_amd64.whl", hash = "sha256:fd93b88d5332069916fa00829ea1b972b7e73abcb1081eee5c905a514b8b59e3"}, - {file = "numexpr-2.8.7-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:5340d2c86d83f52e1a3e7fd97c37d358ae99af9de316bdeeab2565b9b1e622ca"}, - {file = "numexpr-2.8.7-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:f3bdf8cbc00c77a46230c765d242f92d35905c239b20c256c48dbac91e49f253"}, - {file = "numexpr-2.8.7-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d46c47e361fa60966a3339cb4f463ae6151ce7d78ed38075f06e8585d2c8929f"}, - {file = "numexpr-2.8.7-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a371cfc1670a18eea2d5c70abaa95a0e8824b70d28da884bad11931266e3a0ca"}, - {file = "numexpr-2.8.7-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:47a249cecd1382d482a5bf1fac0d11392fb2ed0f7d415ebc4cd901959deb1ec9"}, - {file = "numexpr-2.8.7-cp312-cp312-win32.whl", hash = "sha256:b8a5b2c21c26b62875bf819d375d798b96a32644e3c28bd4ce7789ed1fb489da"}, - {file = "numexpr-2.8.7-cp312-cp312-win_amd64.whl", hash = "sha256:f29f4d08d9b0ed6fa5d32082971294b2f9131b8577c2b7c36432ed670924313f"}, - {file = "numexpr-2.8.7.tar.gz", hash = "sha256:596eeb3bbfebc912f4b6eaaf842b61ba722cebdb8bc42dfefa657d3a74953849"}, -] - [[package]] name = "numpy" version = "1.25.2" @@ -1497,6 +1535,14 @@ files = [ {file = "packaging-23.2.tar.gz", hash = "sha256:048fb0e9405036518eaaf48a55953c750c11e1a1b68e0dd1a9d62ed0c092cfc5"}, ] +[[package]] +name = "paginate" +version = "0.5.6" +summary = "Divides large result sets into pages for easier browsing" +files = [ + {file = "paginate-0.5.6.tar.gz", hash = "sha256:5e6007b6a9398177a7e1648d04fdd9f8c9766a1a945bceac82f1929e8c78af2d"}, +] + [[package]] name = "pandas" version = "2.1.0" @@ -1530,33 +1576,6 @@ files = [ {file = "pandas-2.1.0.tar.gz", hash = "sha256:62c24c7fc59e42b775ce0679cfa7b14a5f9bfb7643cfbe708c960699e05fb918"}, ] -[[package]] -name = "pandas" -version = "2.1.0" -extras = ["excel", "performance"] -requires_python = ">=3.9" -summary = "Powerful data structures for data analysis, time series, and statistics" -dependencies = [ - "bottleneck>=1.3.4", - "numba>=0.55.2", - "numexpr>=2.8.0", - "odfpy>=1.4.1", - "openpyxl>=3.0.10", - "pandas==2.1.0", - "pyxlsb>=1.0.9", - "xlrd>=2.0.1", - "xlsxwriter>=3.0.3", -] -files = [ - {file = "pandas-2.1.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:cda72cc8c4761c8f1d97b169661f23a86b16fdb240bdc341173aee17e4d6cedd"}, - {file = "pandas-2.1.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:d97daeac0db8c993420b10da4f5f5b39b01fc9ca689a17844e07c0a35ac96b4b"}, - {file = "pandas-2.1.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d8c58b1113892e0c8078f006a167cc210a92bdae23322bb4614f2f0b7a4b510f"}, - {file = "pandas-2.1.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:629124923bcf798965b054a540f9ccdfd60f71361255c81fa1ecd94a904b9dd3"}, - {file = "pandas-2.1.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:70cf866af3ab346a10debba8ea78077cf3a8cd14bd5e4bed3d41555a3280041c"}, - {file = "pandas-2.1.0-cp311-cp311-win_amd64.whl", hash = "sha256:d53c8c1001f6a192ff1de1efe03b31a423d0eee2e9e855e69d004308e046e694"}, - {file = "pandas-2.1.0.tar.gz", hash = "sha256:62c24c7fc59e42b775ce0679cfa7b14a5f9bfb7643cfbe708c960699e05fb918"}, -] - [[package]] name = "pandas" version = "2.1.0" @@ -1766,6 +1785,20 @@ files = [ {file = "Pygments-2.16.1.tar.gz", hash = "sha256:1daff0494820c69bc8941e407aa20f577374ee88364ee10a98fdbe0aece96e29"}, ] +[[package]] +name = "pymdown-extensions" +version = "10.4" +requires_python = ">=3.8" +summary = "Extension pack for Python Markdown." +dependencies = [ + "markdown>=3.2", + "pyyaml", +] +files = [ + {file = "pymdown_extensions-10.4-py3-none-any.whl", hash = "sha256:cfc28d6a09d19448bcbf8eee3ce098c7d17ff99f7bd3069db4819af181212037"}, + {file = "pymdown_extensions-10.4.tar.gz", hash = "sha256:bc46f11749ecd4d6b71cf62396104b4a200bad3498cb0f5dad1b8502fe461a35"}, +] + [[package]] name = "pyparsing" version = "3.1.1" @@ -2039,6 +2072,43 @@ files = [ {file = "referencing-0.30.2.tar.gz", hash = "sha256:794ad8003c65938edcdbc027f1933215e0d0ccc0291e3ce20a4d87432b59efc0"}, ] +[[package]] +name = "regex" +version = "2023.10.3" +requires_python = ">=3.7" +summary = "Alternative regular expression module, to replace re." +files = [ + {file = "regex-2023.10.3-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:90a79bce019c442604662d17bf69df99090e24cdc6ad95b18b6725c2988a490e"}, + {file = "regex-2023.10.3-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:c7964c2183c3e6cce3f497e3a9f49d182e969f2dc3aeeadfa18945ff7bdd7051"}, + {file = "regex-2023.10.3-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4ef80829117a8061f974b2fda8ec799717242353bff55f8a29411794d635d964"}, + {file = "regex-2023.10.3-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5addc9d0209a9afca5fc070f93b726bf7003bd63a427f65ef797a931782e7edc"}, + {file = "regex-2023.10.3-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c148bec483cc4b421562b4bcedb8e28a3b84fcc8f0aa4418e10898f3c2c0eb9b"}, + {file = "regex-2023.10.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8d1f21af4c1539051049796a0f50aa342f9a27cde57318f2fc41ed50b0dbc4ac"}, + {file = "regex-2023.10.3-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0b9ac09853b2a3e0d0082104036579809679e7715671cfbf89d83c1cb2a30f58"}, + {file = "regex-2023.10.3-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:ebedc192abbc7fd13c5ee800e83a6df252bec691eb2c4bedc9f8b2e2903f5e2a"}, + {file = "regex-2023.10.3-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:d8a993c0a0ffd5f2d3bda23d0cd75e7086736f8f8268de8a82fbc4bd0ac6791e"}, + {file = "regex-2023.10.3-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:be6b7b8d42d3090b6c80793524fa66c57ad7ee3fe9722b258aec6d0672543fd0"}, + {file = "regex-2023.10.3-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:4023e2efc35a30e66e938de5aef42b520c20e7eda7bb5fb12c35e5d09a4c43f6"}, + {file = "regex-2023.10.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:0d47840dc05e0ba04fe2e26f15126de7c755496d5a8aae4a08bda4dd8d646c54"}, + {file = "regex-2023.10.3-cp311-cp311-win32.whl", hash = "sha256:9145f092b5d1977ec8c0ab46e7b3381b2fd069957b9862a43bd383e5c01d18c2"}, + {file = "regex-2023.10.3-cp311-cp311-win_amd64.whl", hash = "sha256:b6104f9a46bd8743e4f738afef69b153c4b8b592d35ae46db07fc28ae3d5fb7c"}, + {file = "regex-2023.10.3-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:bff507ae210371d4b1fe316d03433ac099f184d570a1a611e541923f78f05037"}, + {file = "regex-2023.10.3-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:be5e22bbb67924dea15039c3282fa4cc6cdfbe0cbbd1c0515f9223186fc2ec5f"}, + {file = "regex-2023.10.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4a992f702c9be9c72fa46f01ca6e18d131906a7180950958f766c2aa294d4b41"}, + {file = "regex-2023.10.3-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:7434a61b158be563c1362d9071358f8ab91b8d928728cd2882af060481244c9e"}, + {file = "regex-2023.10.3-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c2169b2dcabf4e608416f7f9468737583ce5f0a6e8677c4efbf795ce81109d7c"}, + {file = "regex-2023.10.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a9e908ef5889cda4de038892b9accc36d33d72fb3e12c747e2799a0e806ec841"}, + {file = "regex-2023.10.3-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:12bd4bc2c632742c7ce20db48e0d99afdc05e03f0b4c1af90542e05b809a03d9"}, + {file = "regex-2023.10.3-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:bc72c231f5449d86d6c7d9cc7cd819b6eb30134bb770b8cfdc0765e48ef9c420"}, + {file = "regex-2023.10.3-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:bce8814b076f0ce5766dc87d5a056b0e9437b8e0cd351b9a6c4e1134a7dfbda9"}, + {file = "regex-2023.10.3-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:ba7cd6dc4d585ea544c1412019921570ebd8a597fabf475acc4528210d7c4a6f"}, + {file = "regex-2023.10.3-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:b0c7d2f698e83f15228ba41c135501cfe7d5740181d5903e250e47f617eb4292"}, + {file = "regex-2023.10.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:5a8f91c64f390ecee09ff793319f30a0f32492e99f5dc1c72bc361f23ccd0a9a"}, + {file = "regex-2023.10.3-cp312-cp312-win32.whl", hash = "sha256:ad08a69728ff3c79866d729b095872afe1e0557251da4abb2c5faff15a91d19a"}, + {file = "regex-2023.10.3-cp312-cp312-win_amd64.whl", hash = "sha256:39cdf8d141d6d44e8d5a12a8569d5a227f645c87df4f92179bd06e2e2705e76b"}, + {file = "regex-2023.10.3.tar.gz", hash = "sha256:3fef4f844d2290ee0ba57addcec17eec9e3df73f10a2748485dfd6a3a188cc0f"}, +] + [[package]] name = "requests" version = "2.31.0" @@ -2055,19 +2125,6 @@ files = [ {file = "requests-2.31.0.tar.gz", hash = "sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1"}, ] -[[package]] -name = "resampy" -version = "0.4.2" -summary = "Efficient signal resampling" -dependencies = [ - "numba>=0.53", - "numpy>=1.17", -] -files = [ - {file = "resampy-0.4.2-py3-none-any.whl", hash = "sha256:4340b6c4e685a865621dfcf016e2a3dd49d865446b6025e30fe88567f22e052e"}, - {file = "resampy-0.4.2.tar.gz", hash = "sha256:0a469e6ddb89956f4fd6c88728300e4bbd186fae569dd4fd17dae51a91cbaa15"}, -] - [[package]] name = "rfc3339-validator" version = "0.1.4" @@ -2185,53 +2242,6 @@ files = [ {file = "rpds_py-0.10.6.tar.gz", hash = "sha256:4ce5a708d65a8dbf3748d2474b580d606b1b9f91b5c6ab2a316e0b0cf7a4ba50"}, ] -[[package]] -name = "scikit-image" -version = "0.22.0" -requires_python = ">=3.9" -summary = "Image processing in Python" -dependencies = [ - "imageio>=2.27", - "lazy-loader>=0.3", - "networkx>=2.8", - "numpy>=1.22", - "packaging>=21", - "pillow>=9.0.1", - "scipy>=1.8", - "tifffile>=2022.8.12", -] -files = [ - {file = "scikit_image-0.22.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:95d6da2d8a44a36ae04437c76d32deb4e3c993ffc846b394b9949fd8ded73cb2"}, - {file = "scikit_image-0.22.0-cp311-cp311-macosx_12_0_arm64.whl", hash = "sha256:2c6ef454a85f569659b813ac2a93948022b0298516b757c9c6c904132be327e2"}, - {file = "scikit_image-0.22.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e87872f067444ee90a00dd49ca897208308645382e8a24bd3e76f301af2352cd"}, - {file = "scikit_image-0.22.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c5c378db54e61b491b9edeefff87e49fcf7fdf729bb93c777d7a5f15d36f743e"}, - {file = "scikit_image-0.22.0-cp311-cp311-win_amd64.whl", hash = "sha256:2bcb74adb0634258a67f66c2bb29978c9a3e222463e003b67ba12056c003971b"}, - {file = "scikit_image-0.22.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:003ca2274ac0fac252280e7179ff986ff783407001459ddea443fe7916e38cff"}, - {file = "scikit_image-0.22.0-cp312-cp312-macosx_12_0_arm64.whl", hash = "sha256:cf3c0c15b60ae3e557a0c7575fbd352f0c3ce0afca562febfe3ab80efbeec0e9"}, - {file = "scikit_image-0.22.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f5b23908dd4d120e6aecb1ed0277563e8cbc8d6c0565bdc4c4c6475d53608452"}, - {file = "scikit_image-0.22.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:be79d7493f320a964f8fcf603121595ba82f84720de999db0fcca002266a549a"}, - {file = "scikit_image-0.22.0-cp312-cp312-win_amd64.whl", hash = "sha256:722b970aa5da725dca55252c373b18bbea7858c1cdb406e19f9b01a4a73b30b2"}, - {file = "scikit_image-0.22.0.tar.gz", hash = "sha256:018d734df1d2da2719087d15f679d19285fce97cd37695103deadfaef2873236"}, -] - -[[package]] -name = "scikit-maad" -version = "1.4.0" -requires_python = ">=3.8" -summary = "Open-source and modular toolbox for quantitative soundscape analysis in Python" -dependencies = [ - "matplotlib>=3.6", - "numpy>=1.21", - "pandas>=1.5", - "resampy>=0.4", - "scikit-image>=0.19", - "scipy>=1.8", -] -files = [ - {file = "scikit_maad-1.4.0-py3-none-any.whl", hash = "sha256:964038e88e3e81328dd56a81fe0f083862d1a639108c4b7cdc32ac2f5e83461e"}, - {file = "scikit_maad-1.4.0.tar.gz", hash = "sha256:163ce8c79aada0f73f21499fd54002345fd11e611e955ddbc95a2d24e3068a38"}, -] - [[package]] name = "scipy" version = "1.9.3" @@ -2259,21 +2269,6 @@ files = [ {file = "scipy-1.9.3.tar.gz", hash = "sha256:fbc5c05c85c1a02be77b1ff591087c83bc44579c6d2bd9fb798bb64ea5e1a027"}, ] -[[package]] -name = "seaborn" -version = "0.13.0" -requires_python = ">=3.8" -summary = "Statistical data visualization" -dependencies = [ - "matplotlib!=3.6.1,>=3.3", - "numpy!=1.24.0,>=1.20", - "pandas>=1.2", -] -files = [ - {file = "seaborn-0.13.0-py3-none-any.whl", hash = "sha256:70d740828c48de0f402bb17234e475eda687e3c65f4383ea25d0cc4728f7772e"}, - {file = "seaborn-0.13.0.tar.gz", hash = "sha256:0e76abd2ec291c655b516703c6a022f0fd5afed26c8e714e8baef48150f73598"}, -] - [[package]] name = "send2trash" version = "1.8.2" @@ -2314,27 +2309,6 @@ files = [ {file = "sniffio-1.3.0.tar.gz", hash = "sha256:e60305c5e5d314f5389259b7f22aaa33d8f7dee49763119234af3755c55b9101"}, ] -[[package]] -name = "soundscapy" -version = "0.5.3" -requires_python = "<4.0,>=3.9" -summary = "A python library for analysing and visualising soundscape assessments." -dependencies = [ - "PyYAML>=6.0.1", - "acoustics>=0.2.6", - "matplotlib>=3.7.2", - "mosqito>=1.0.8", - "pandas[excel,performance]>=2.0.3", - "scikit-maad>=1.4.0", - "seaborn>=0.12.2", - "setuptools>=68.0.0", - "tqdm>=4.66.1", -] -files = [ - {file = "soundscapy-0.5.3-py3-none-any.whl", hash = "sha256:6f9a16ead05724d3d3252669646b84f3e223cd9384aebdaa56a0e94523f89e97"}, - {file = "soundscapy-0.5.3.tar.gz", hash = "sha256:3f1e2c2a1eb1d266b0e9e8ed58d82fb27d872e984a0d3c9101afe5301d677b0c"}, -] - [[package]] name = "soupsieve" version = "2.5" @@ -2359,16 +2333,6 @@ files = [ {file = "stack_data-0.6.3.tar.gz", hash = "sha256:836a778de4fec4dcd1dcd89ed8abff8a221f58308462e1c4aa2a3cf30148f0b9"}, ] -[[package]] -name = "tabulate" -version = "0.9.0" -requires_python = ">=3.7" -summary = "Pretty-print tabular data" -files = [ - {file = "tabulate-0.9.0-py3-none-any.whl", hash = "sha256:024ca478df22e9340661486f85298cff5f6dcdba14f3813e8830015b9ed1948f"}, - {file = "tabulate-0.9.0.tar.gz", hash = "sha256:0095b12bf5966de529c0feb1fa08671671b3368eec77d7ef7ab114be2c068b3c"}, -] - [[package]] name = "terminado" version = "0.17.1" @@ -2384,19 +2348,6 @@ files = [ {file = "terminado-0.17.1.tar.gz", hash = "sha256:6ccbbcd3a4f8a25a5ec04991f39a0b8db52dfcd487ea0e578d977e6752380333"}, ] -[[package]] -name = "tifffile" -version = "2023.9.26" -requires_python = ">=3.9" -summary = "Read and write TIFF files" -dependencies = [ - "numpy", -] -files = [ - {file = "tifffile-2023.9.26-py3-none-any.whl", hash = "sha256:1de47fa945fddaade256e25ad4f375ae65547f3c1354063aded881c32a64cf89"}, - {file = "tifffile-2023.9.26.tar.gz", hash = "sha256:67e355e4595aab397f8405d04afe1b4ae7c6f62a44e22d933fee1a571a48c7ae"}, -] - [[package]] name = "tinycss2" version = "1.2.1" @@ -2410,6 +2361,16 @@ files = [ {file = "tinycss2-1.2.1.tar.gz", hash = "sha256:8cff3a8f066c2ec677c06dbc7b45619804a6938478d9d73c284b29d14ecb0627"}, ] +[[package]] +name = "toml" +version = "0.10.2" +requires_python = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" +summary = "Python Library for Tom's Obvious, Minimal Language" +files = [ + {file = "toml-0.10.2-py2.py3-none-any.whl", hash = "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b"}, + {file = "toml-0.10.2.tar.gz", hash = "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f"}, +] + [[package]] name = "tornado" version = "6.3.3" @@ -2429,19 +2390,6 @@ files = [ {file = "tornado-6.3.3.tar.gz", hash = "sha256:e7d8db41c0181c80d76c982aacc442c0783a2c54d6400fe028954201a2e032fe"}, ] -[[package]] -name = "tqdm" -version = "4.66.1" -requires_python = ">=3.7" -summary = "Fast, Extensible Progress Meter" -dependencies = [ - "colorama; platform_system == \"Windows\"", -] -files = [ - {file = "tqdm-4.66.1-py3-none-any.whl", hash = "sha256:d302b3c5b53d47bce91fea46679d9c3c6508cf6332229aa1e7d8653723793386"}, - {file = "tqdm-4.66.1.tar.gz", hash = "sha256:d88e651f9db8d8551a62556d3cff9e3034274ca5d66e93197cf2490e2dcb69c7"}, -] - [[package]] name = "traitlets" version = "5.13.0" diff --git a/pyproject.toml b/pyproject.toml index 7b245bf..eb89d3b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -22,10 +22,14 @@ test = [ docs = [ "jupyter>=1.0.0", "mkdocs>=1.5.3", + "mkdocs-material>=9.4.8", + "mkdocstrings[python]>=0.23.0", + "mkdocs-jupyter>=0.24.6", + "markdown>=3.5.1", + "pymdown-extensions>=10.4", ] dev = [ "setuptools>=68.2.2", - "soundscapy>=0.5.3", ] [build-system] requires = ["pdm-backend"] diff --git a/src/circumplex/circumplex.py b/src/circumplex/circumplex.py index 5b1f27a..2cdb316 100644 --- a/src/circumplex/circumplex.py +++ b/src/circumplex/circumplex.py @@ -96,12 +96,12 @@ def __str__(self): # TODO: Add param results return f"{self.label}: {self.params})" - def profile_plot(self, ax=None) -> tuple: + def profile_plot(self, ax=None) -> plt.Axes: """ Plot the SSM profile. Returns: - tuple: A tuple containing the figure and axis objects. + plt.Axes: A tuple containing the figure and axis objects. """ return profile_plot( self.amplitude, @@ -114,12 +114,12 @@ def profile_plot(self, ax=None) -> tuple: ax=ax, ) - def plot(self): + def plot(self) -> plt.Axes: """ Plot the results in the circumplex Returns: - tuple: A tuple containing the figure and axis objects. + plt.Axes: A tuple containing the figure and axis objects. """ fig, ax = plt.subplots(subplot_kw={"projection": "polar"}) ax.plot( @@ -136,7 +136,7 @@ class SSMResults(object): A class to store the results of a SSM analysis. Attributes: - results (dict): A dictionary containing the results of the SSM analysis. + results (list[SSMParams]): A list containing the SSMParams results of the SSM analysis. measures (list): A list of the names of the measures included in `scores`. grouping (list): A list of the names of the groups included in `scores`. """ @@ -185,12 +185,12 @@ def query_label(self, label: str) -> SSMParams: f"No results found for {label}" ) # Raised if the label is never found - def plot(self, colors=None, legend=True, *args, **kwargs) -> tuple: + def plot(self, colors=None, legend=True, *args, **kwargs) -> plt.Axes: """ Plot the results in the circumplex Returns: - tuple: A tuple containing the figure and axis objects. + plt.Axes: A tuple containing the figure and axis objects. """ fig, ax = plt.subplots(subplot_kw={"projection": "polar"}) if colors is None: @@ -208,12 +208,12 @@ def plot(self, colors=None, legend=True, *args, **kwargs) -> tuple: fig.legend(loc="upper right", bbox_to_anchor=(1.2, 1)) return fig, ax - def profile_plots(self, axes=None) -> None: + def profile_plots(self, axes=None) -> plt.Axes: """ Plot the SSM profiles. Returns: - None + plt.Axes: A tuple containing the figure and axis objects. """ if axes is None: fig, axes = plt.subplots( @@ -242,7 +242,6 @@ def ssm_analyse( Analyse a set of data using the SSM method. Args: - data (pd.DataFrame): A dataframe containing the data to be analysed. scales (list): A list of the names of the circumplex scales to be included in the analysis. measures (list, optional): A list of the names of the measures to be included in the analysis. Defaults to None. @@ -250,7 +249,6 @@ def ssm_analyse( angles (tuple, optional): A tuple containing the angular displacement of each circumplex scale included in `scores`. Defaults to OCTANTS. Returns: - SSMResults: A SSMResults object containing the results of the analysis. """ @@ -280,7 +278,6 @@ def ssm_analyse_grouped_corrs( Perform SSM analysis of correlations for a set of grouped data. Args: - data (pd.DataFrame): A dataframe containing the data to be analysed. scales (tuple): A list of the names of the circumplex scales to be included in the analysis. measures (list): A list of the names of the measures to be included in the analysis. @@ -288,7 +285,6 @@ def ssm_analyse_grouped_corrs( angles (tuple, optional): A tuple containing the angular displacement of each circumplex scale included in `scores`. Defaults to OCTANTS. Returns: - SSMResults: A SSMResults object containing the results of the analysis. """ res = [] @@ -319,7 +315,6 @@ def ssm_analyse_corrs( Perform SSM analysis of correlations for a set of data. Args: - data (pd.DataFrame): A dataframe containing the data to be analysed. scales (tuple): A list of the names of the circumplex scales to be included in the analysis. measures (list): A list of the names of the measures to be included in the analysis. @@ -327,7 +322,6 @@ def ssm_analyse_corrs( group (str, optional): The name of the group to be included in the analysis. Defaults to None. Returns: - SSMResults: A SSMResults object containing the results of the analysis. """ res = [] @@ -351,14 +345,12 @@ def ssm_analyse_means( Perform SSM analysis of means for a set of data. Args: - data (pd.DataFrame): A dataframe containing the data to be analysed. scales (tuple): A list of the names of the circumplex scales to be included in the analysis. grouping (list): A list of the names of the groups to be included in the analysis. angles (tuple, optional): A tuple containing the angular displacement of each circumplex scale included in `scores`. Defaults to OCTANTS. Returns: - SSMResults: A SSMResults object containing the results of the analysis. """ means = data.groupby(grouping)[scales].mean() @@ -386,7 +378,7 @@ def _r2_score(y_true: np.array, y_pred: np.array): return 1 - (ss_res / ss_tot) -def ssm_parameters(scores, angles, bounds=BOUNDS): +def ssm_parameters(scores, angles, bounds=BOUNDS) -> tuple: """Calculate SSM parameters (without confidence intervals) for a set of scores. Args: @@ -398,7 +390,6 @@ def ssm_parameters(scores, angles, bounds=BOUNDS): tuple: A tuple containing the elevation, x-value, y-value, amplitude, displacement, and R2 fit of the SSM curve. Examples: - >>> scores = np.array([-0.5, 0, 0.25, 0.51, 0.52, 0.05, -0.26, -0.7]) >>> angles = OCTANTS >>> results = ssm_parameters(scores, angles) @@ -426,12 +417,12 @@ def polar2cart(r, theta): def profile_plot( amplitude, displacement, elevation, r2, angles, scores, label, ax=None -): +) -> plt.Axes: """ Plot the SSM profile. Returns: - tuple: A tuple containing the figure and axis objects. + plt.Axes: A tuple containing the figure and axis objects. """ thetas = np.linspace(0, 360, 1000) fit = cosine_form(thetas, amplitude, displacement, elevation)