Merge branch 'release-2.2.0'

.github/pull_request_template.md

@@ -0,0 +1,34 @@
+# Description
+
+## Motivation
+Please describe your motivation for making these changes.
+
+## Relevant Issues
+* List any issues relating to this pull request.
+
+## Changes
+* List the changes you made.
+
+## New Dependencies
+* List any new dependencies required to implement these changes.
+
+## Change Magnitude
+Indicate if the magnitude of your enhancement is a major, minor, or patch. For 
+clarification on these terms, please read the 
+[semantic versioning guide](https://semver.org/?fbclid=IwAR1xgl6Hioqq9BOE9a8FdU6pVdPU3CAPeOUTldSZU1rIEv9d4Jw6ZyE0v9g)
+documentation.
+
+# Checklist
+
+- [ ] You've created an issue with an enhancement label detailing these changes.
+- [ ] All calculations use S.I. units.
+- [ ] You've formatted your code using black.
+- [ ] You've used a line-length of 88.
+- [ ] All modules, scripts, classes, methods, and functions you've written have 
+docstrings.
+- [ ] Your docstrings use the reStructuredText format.
+- [ ] Your code is well documented using block comments.
+- [ ] If you've made any major changes, you've also created new tests in the tests 
+package.
+- [ ] If you use any code or equations from someone else, you've cited your sources in 
+a comment or docstring.

CODE_OF_CONDUCT.md

@@ -2,103 +2,120 @@
 
 ## Our Pledge
 
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for 
-everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender 
-identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, 
-religion, or sexual identity and orientation. 
+We as members, contributors, and leaders pledge to make participation in our community 
+a harassment-free experience for everyone, regardless of age, body size, visible or 
+invisible disability, ethnicity, sex characteristics, gender identity and expression, 
+level of experience, education, socio-economic status, nationality, personal 
+appearance, race, religion, or sexual identity and orientation. 
 
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. 
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, 
+inclusive, and healthy community. 
 
 ## Our Standards
 
-Examples of behavior that contributes to a positive environment for our community include: 
+Examples of behavior that contributes to a positive environment for our community 
+include: 
 
 * Demonstrating empathy and kindness toward other people
 * Being respectful of differing opinions, viewpoints, and experiences
 * Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience 
+* Accepting responsibility and apologizing to those affected by our mistakes, and 
+learning from the experience 
 * Focusing on what is best not just for us as individuals, but for the overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or advances of any kind 
+* The use of sexualized language or imagery, and sexual attention or advances of any 
+kind 
 * Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or email address, without their explicit permission 
-* Other conduct which could reasonably be considered inappropriate in a professional setting 
+* Publishing others' private information, such as a physical or email address, without 
+their explicit permission 
+* Other conduct which could reasonably be considered inappropriate in a professional 
+setting 
 
 ## Enforcement Responsibilities
 
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take 
-appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, 
-offensive, or harmful. 
+Community leaders are responsible for clarifying and enforcing our standards of 
+acceptable behavior and will take appropriate and fair corrective action in response to 
+any behavior that they deem inappropriate, threatening, offensive, or harmful. 
 
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, 
-issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for 
-moderation decisions when appropriate. 
+Community leaders have the right and responsibility to remove, edit, or reject 
+comments, commits, code, wiki edits, issues, and other contributions that are not 
+aligned to this Code of Conduct, and will communicate reasons for moderation decisions 
+when appropriate. 
 
 ## Scope
 
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially 
-representing the community in public spaces. Examples of representing our community include using an official e-mail 
-address, posting via an official social media account, or acting as an appointed representative at an online or offline 
-event. 
+This Code of Conduct applies within all community spaces, and also applies when an 
+individual is officially representing the community in public spaces. Examples of 
+representing our community include using an official e-mail address, posting via an 
+official social media account, or acting as an appointed representative at an online 
+or offline event. 
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders 
-responsible for enforcement at [email protected]. All complaints will be reviewed and investigated promptly and 
-fairly. 
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to 
+the community leaders responsible for enforcement at [email protected]. All 
+complaints will be reviewed and investigated promptly and fairly. 
 
-All community leaders are obligated to respect the privacy and security of the reporter of any incident. 
+All community leaders are obligated to respect the privacy and security of the reporter 
+of any incident. 
 
 ## Enforcement Guidelines
 
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they 
-deem in violation of this Code of Conduct: 
+Community leaders will follow these Community Impact Guidelines in determining the 
+consequences for any action they deem in violation of this Code of Conduct: 
 
 ### 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the 
-community. 
+**Community Impact**: Use of inappropriate language or other behavior deemed 
+unprofessional or unwelcome in the community. 
 
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the 
-violation and an explanation of why the behavior was inappropriate. A public apology may be requested. 
+**Consequence**: A private, written warning from community leaders, providing clarity 
+around the nature of the violation and an explanation of why the behavior was 
+inappropriate. A public apology may be requested. 
 
 ### 2. Warning
 
 **Community Impact**: A violation through a single incident or series of actions.
 
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including 
-unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes 
-avoiding interactions in community spaces as well as external channels like social media. Violating these terms may 
-lead to a temporary or permanent ban. 
+**Consequence**: A warning with consequences for continued behavior. No interaction 
+with the people involved, including unsolicited interaction with those enforcing the 
+Code of Conduct, for a specified period of time. This includes avoiding interactions in 
+community spaces as well as external channels like social media. Violating these terms 
+may lead to a temporary or permanent ban. 
 
 ### 3. Temporary Ban
 
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. 
+**Community Impact**: A serious violation of community standards, including sustained 
+inappropriate behavior. 
 
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a 
-specified period of time. No public or private interaction with the people involved, including unsolicited interaction 
-with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent 
-ban. 
+**Consequence**: A temporary ban from any sort of interaction or public communication 
+with the community for a specified period of time. No public or private interaction 
+with the people involved, including unsolicited interaction with those enforcing the 
+Code of Conduct, is allowed during this period. Violating these terms may lead to a 
+permanent ban. 
 
 ### 4. Permanent Ban
 
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate 
-behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. 
+**Community Impact**: Demonstrating a pattern of violation of community standards, 
+including sustained inappropriate behavior, harassment of an individual, or aggression 
+toward or disparagement of classes of individuals. 
 
-**Consequence**: A permanent ban from any sort of public interaction within the community. 
+**Consequence**: A permanent ban from any sort of public interaction within the 
+community. 
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at 
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, 
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 
 
-Community Impact Guidelines were inspired by 
+Community Impact Guidelines were inspired by
 [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). 
 
 [homepage]: https://www.contributor-covenant.org
 
-For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. 
-Translations are available at https://www.contributor-covenant.org/translations.
+For answers to common questions about this code of conduct, see the FAQ at 
+https://www.contributor-covenant.org/faq. Translations are available at 
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,95 @@
+# Contributing Guidelines
+
+We are excited to welcome new users, so thank you for considering contributing to Ptera
+Software! Hopefully this help you get started. If you have any questions not answered
+here, open an issue request. We'll respond and to help out!
+
+## Before Contributing
+
+Before contributing, you should check out Ptera Software's other reference documents (
+listed in recommended reading order :wink:):
+
+* [README](README.md)
+* [Code of Conduct](CODE_OF_CONDUCT.md)
+* [Security Policy](SECURITY.md)
+* [License](LICENSE.txt)
+
+## Contributing
+
+There are three pathways to contributing: [reporting a bug](#reporting-a-bug),
+[requesting an enhancement](#requesting-an-enhancement),
+and [creating an enhancement](#creating-an-enhancement).
+
+### Reporting a Bug
+
+**If the bug you've found is a security vulnerability, please do not post it as an
+issue. Instead, follow the guidelines in our [security policy](SECURITY.md).**
+
+If you discover a bug in Ptera Software, head over to our
+[issues page](https://github.com/camUrban/PteraSoftware/issues). Then, use to search bar
+to check that it doesn't already have an open issue. If there is an open issue, feel
+free to comment on this issue or use one of the emoji reactions. This will let us know
+the problem is being experienced by multiple users, and make us move extra quickly to
+fixing it!
+
+If no one else has reported this bug, do so by creating a new issue! Please use our
+[bug report template](.github/ISSUE_TEMPLATE/bug_report.md) so that we get all the
+information we need to help you ASAP. Also, add the `bug` and `help wanted ` labels (and
+any other applicable labels) to the issue.
+
+### Requesting an Enhancement
+
+As with bugs, the best way to request a feature or to suggest an enhancement is to open
+issue. Again, make sure you search
+the [issues page](https://github.com/camUrban/PteraSoftware/issues) to see if anyone
+else has requested the same thing before creating a new issue. If there is an open
+issue, feel free to comment on this issue or use one of the emoji reactions. This will
+let us know that multiple users would benefit from this change, and we'll try extra hard
+to implement it quickly!
+
+If no one else has requested this change, do so by creating a new issue! Please use our
+[feature request template](.github/ISSUE_TEMPLATE/feature_request.md) so that we get all
+the information we need to help you ASAP. Also, add the `enhancement` and `help wanted`
+labels (and any other applicable labels) to the issue.
+
+### Creating an Enhancement
+
+If you can't think of a particular enhancement you'd benefit from, search for issues
+labeled `help wanted` or `good first issue` for inspiration.
+
+If you have your own idea for an enhancement, we recommend searching the
+[issues page](https://github.com/camUrban/PteraSoftware/issues) to make sure there is no
+other active development on this enhancement. If you find someone else working on the
+same feature or change, add a comment letting them know you'd like to help out!
+
+If you do not see anything on the issues page, we recommend opening an enhancement issue
+as its possible the feature you're about to implement already exists, and we'll comment
+letting you know! Also, be sure to indicate in your post that you'll take charge of
+implementing this change (otherwise, someone else might start working on your request).
+
+Next, we recommend you clone the Ptera Software repository, and then create new feature
+branch from your develop branch. You should create a different feature branch for each
+enhancement you are working on. Follow the
+[GitFlow methodology](https://nvie.com/posts/a-successful-git-branching-model/?fbclid=IwAR3F9IwEXG1T6oMn5Bnk84_u0mv_RAEI5qTJQE7Puovj0hbGZcA8ly_KXYI)
+for creating and managing feature branches.
+
+In this feature branch, implement your enhancement. Be sure to commit frequently and
+write detailed commit messages. Additionally, please try to use the follow style guide:
+
+* Always use S.I. units for all calculations and results.
+* Format your code using the [black](https://github.com/psf/black).
+* Use a line length of 88 (which is black's default).
+* All modules, scripts, classes, methods, and functions should have
+  [docstrings](https://realpython.com/documenting-python-code/#docstring-types).
+* Use the reStructuredText docstring format.
+* Your code itself should be well documented using block comments.
+* Use tagging (`TODO`, `BUG`, etc.) to mark areas of the code that need changing.
+* Major new functionality should also include new tests, which you should add to the
+  tests package.
+* If you use any code or equations from someone else, please be sure to cite your
+  sources in a comment or docstring.
+
+Once you've finished implementing the enhancement, push your feature branch to your
+clone of Ptera Software. Then, make a pull request to merge your feature branch with the
+original Ptera Software's develop branch using our
+[pull request template](.github/pull_request_template.md).

LICENSE.txt

@@ -2,15 +2,19 @@ MIT License
 
 Copyright (c) 2022 Cameron Urban
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
-rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
-persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+software and associated documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the following
+conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
-Software.
+The above copyright notice and this permission notice shall be included in all copies or
+ substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
-WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
-OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+ PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+ OR OTHER DEALINGS IN THE SOFTWARE.