diff --git a/.coveralls.yml b/.coveralls.yml new file mode 100644 index 0000000..84b054c --- /dev/null +++ b/.coveralls.yml @@ -0,0 +1,3 @@ +repo_token: hxJrvjqiH2xBI7eit7BAb7FidH0LeYpGq +service_name: github-action + diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000..68f5e51 --- /dev/null +++ b/.flake8 @@ -0,0 +1,5 @@ +[flake8] +ignore = E203, E266, E501, W503 +max-line-length = 88 +max-complexity = 18 +select = B,C,E,F,W,T4 diff --git a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..f2e90f0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md @@ -0,0 +1,15 @@ +* HapiSM version: +* Python version: +* Operating System: + +### Description + +Describe what you were trying to get done. +Tell us what happened, what went wrong, and what you expected to happen. + +### What I Did + +``` +Paste the command(s) you ran and the output. +If there was a crash, please include the traceback here. +``` diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md new file mode 100644 index 0000000..b894315 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom.md @@ -0,0 +1,8 @@ +--- +name: Custom issue template +about: Describe this issue template's purpose here. +title: '' +labels: '' +assignees: '' + +--- diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..b690835 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,13 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + + +version: 2 +updates: +- package-ecosystem: pip + directory: "/" + schedule: + interval: daily + open-pull-requests-limit: 10 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..0720d9e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,38 @@ +# Description + +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +# How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [ ] Test A +- [ ] Test B + +**Test Configuration**: +* Firmware version: +* Hardware: +* Toolchain: +* SDK: + +# Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules diff --git a/.github/workflows/automerge.yml b/.github/workflows/automerge.yml new file mode 100644 index 0000000..e8e5902 --- /dev/null +++ b/.github/workflows/automerge.yml @@ -0,0 +1,18 @@ +on: + status: {} + check_suite: + types: + - completed + +jobs: + automerge-action: + runs-on: ubuntu-latest + name: automerge + steps: + - name: checkout + uses: actions/checkout@v2 + - name: automerge-action + id: automerge-action + uses: conda-forge/automerge-action@master + with: + github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/clones_count.yml b/.github/workflows/clones_count.yml new file mode 100644 index 0000000..8ad6a42 --- /dev/null +++ b/.github/workflows/clones_count.yml @@ -0,0 +1,39 @@ +name: GitHub Clone Count for 14 days at every 8 hours + +# Controls when the action will run. +on: + schedule: + - cron: "0 */8 * * *" + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v2 + + - name: Parse clone count using REST API + run: | + curl --user "${{ github.actor }}:${{ secrets.SECRET_TOKEN }}" \ + -H "Accept: application/vnd.github.v3+json" \ + https://api.github.com/repos/${{ github.repository }}/traffic/clones \ + > clone.json + + - name: Add to git repo + run: | + git add . + git config --global user.name "GitHub Action" + git config --global user.email "action@github.com" + git commit -m "Automated clone.json update" + + - name: Push + uses: ad-m/github-push-action@master + with: + github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 0000000..9f24714 --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,72 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ main ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ main ] + schedule: + - cron: '35 19 * * 1' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'python' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] + # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v2 + + # ℹ️ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + + # - run: | + # echo "Run, Build Application using script" + # ./location_of_script_within_repo/buildscript.sh + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 diff --git a/.github/workflows/webservices.yml b/.github/workflows/webservices.yml new file mode 100644 index 0000000..78f51e6 --- /dev/null +++ b/.github/workflows/webservices.yml @@ -0,0 +1,12 @@ +on: repository_dispatch + +jobs: + webservices: + runs-on: ubuntu-latest + name: webservices + steps: + - name: webservices + id: webservices + uses: conda-forge/webservices-dispatch-action@master + with: + github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml new file mode 100644 index 0000000..d19bf87 --- /dev/null +++ b/.github/workflows/workflow.yml @@ -0,0 +1,65 @@ +name: CI +on: [push, pull_request] +jobs: + Run: + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [ ubuntu-latest] #, macos-latest, windows-latest + python-version: ["3.9" ] # "3.7", "3.8", + env: + OS: ${{ matrix.os }} + + steps: + - uses: actions/checkout@master + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@master + with: + python-version: ${{ matrix.python-version }} + architecture: x64 + - uses: conda-incubator/setup-miniconda@v2 + with: + miniconda-version: "latest" + channels: conda-forge + allow-softlinks: true + channel-priority: flexible + show-channel-urls: true + + - name: Install dependencies + run: | + $CONDA/bin/conda env update --file environment.yml --name base + python setup.py install + +# - name: Lint with flake8 +# run: | +# # add CONDA/bin/ in front of everything +# $CONDA/bin/conda install flake8 +# # stop the build if there are Python syntax errors or undefined names +# $CONDA/bin/flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics +# # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide +# $CONDA/bin/flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + - name: Generate coverage report +# working-directory: ../ + run: | + pwd + $CONDA/bin/pytest --cov=pyramids --cov-report=xml + +# - name: Upload coverage to Codecov +# uses: codecov/codecov-action@v1 +# with: +# token: ${{ secrets.CODECOV_TOKEN }} +# files: ./coverage1.xml,./coverage2.xml +# directory: ./coverage/reports/ +# flags: unittests +# env_vars: OS,PYTHON +# name: codecov-umbrella +# fail_ci_if_error: true +# path_to_write_report: ./coverage/codecov_report.txt +# verbose: true + + - name: Coveralls GitHub Action + uses: coverallsapp/github-action@1.1.3 + with: + token: ${{ secrets.CODECOV_TOKEN }} + files: ./coverage1.xml,./coverage2.xml + directory: ./coverage/reports/ \ No newline at end of file diff --git a/.gitignore b/.gitignore index b6e4761..fb4c942 100644 --- a/.gitignore +++ b/.gitignore @@ -20,7 +20,6 @@ parts/ sdist/ var/ wheels/ -pip-wheel-metadata/ share/python-wheels/ *.egg-info/ .installed.cfg @@ -43,6 +42,7 @@ htmlcov/ .nox/ .coverage .coverage.* +.coveragerc .cache nosetests.xml coverage.xml @@ -50,6 +50,8 @@ coverage.xml *.py,cover .hypothesis/ .pytest_cache/ +cover/ +*junit-* # Translations *.mo @@ -72,6 +74,7 @@ instance/ docs/_build/ # PyBuilder +.pybuilder/ target/ # Jupyter Notebook @@ -81,15 +84,23 @@ target/ profile_default/ ipython_config.py -# pyenv -.python-version +# IDEs +.mr.developer.cfg +.project +.pydevproject +.settings +.idea -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock +# Complexity +output/*.html +output/*/index.html + +# Sphinx +docs/_build + + +# vim backup files +.*.sw? # PEP 582; used by e.g. github.com/David-OConnor/pyflow __pypackages__/ @@ -101,7 +112,7 @@ celerybeat.pid # SageMath parsed files *.sage.py -# Environments +# virtualenvs .env .venv env/ @@ -114,16 +125,24 @@ venv.bak/ .spyderproject .spyproject -# Rope project settings -.ropeproject +*.npy +*.pkl + +# conda smithy ci-skeleton start +build_artifacts +# conda smithy ci-skeleton end + -# mkdocs documentation -/site +.idea/ +*.iml -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json +*.qgz +*.png +.vscode -# Pyre type checker -.pyre/ +.xml +.idea/pyramids.iml +.idea/.gitignore +.idea +mo_* +conda/ \ No newline at end of file diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..5450999 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,77 @@ +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.3.0 + hooks: +# - id: check-yaml +# name: "[yaml - check] validate yaml" + - id: end-of-file-fixer + name: "[py - check] validate yaml" + - id: trailing-whitespace + name: "[file - format] trim trailing whitespace" + args: [ --markdown-linebreak-ext=md ] + - id: check-added-large-files + name: "[file - check] large file" + args: [ --maxkb=5000 ] + - id: check-docstring-first + name: "[py - check] docstring first" + files: /examples + types : [file, python ] + - id: check-json + name: "[json - check] validate json" + - id: check-merge-conflict + name: "[git - check] merge conflict" + - id: debug-statements + name: "[py - check] debug statements" + - id: detect-private-key + name: "[cred - check] private keys" + - id: fix-encoding-pragma + name: "[file - format] coding pragma" + args: [ --remove ] + - id: mixed-line-ending + name: "[file - format] mixed line ending" + args: [ --fix=auto ] + - id: pretty-format-json + name: "[json - format] pretty json" + args: [ --autofix, + --indent=4, + --no-sort-keys ] + - id: requirements-txt-fixer + name: "[reqs - format] fix requirements.txt" + +# - repo: https://github.com/PyCQA/docformatter +# rev: v1.4 +# hooks: +# - id: docformatter +## name: "[py - format] docformatter" +## args: [ -i, --wrap-summaries, "0" ] + +# - repo: https://github.com/PyCQA/pydocstyle +# rev: 6.1.1 +# hooks: +# - id: pydocstyle +# name: "[py - check] pydocstyle" +# files: ^Hapi/ + # TODO : uncheck later and fix all the problems of line too long +#- repo: https://gitlab.com/pycqa/flake8 +# rev: 3.8.4 +# hooks: +# - id: flake8 +# name: "[py - check] flake8" +# language_version: python3.8 +# TODO : this hook does not fix the files + #- repo: https://github.com/psf/black +# rev: 19.3b0 +# hooks: +# - id: black +- repo: https://github.com/pre-commit/mirrors-isort + rev: v5.7.0 + hooks: + - id: isort + name: "[py - format] isort" + +#- repo: https://github.com/ambv/black +# rev: 20.8b1 +# hooks: +# - id: black +# name: "[py - format] black" +# language_version: python3.8 diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..7019f51 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,19 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +conda: + environment: docs/environment.yml +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py +#Build documentation with MkDocs +#mkdocs: +# configuration: mkdocs.yml + + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all diff --git a/AUTHORS.rst b/AUTHORS.rst new file mode 100644 index 0000000..34d673f --- /dev/null +++ b/AUTHORS.rst @@ -0,0 +1,13 @@ +======= +Credits +======= + +Development Lead +---------------- + +* Mostafa Farrag + +Contributors +------------ + +None yet. Why not be the first? diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..457d89e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,94 @@ +# Citizen Code of Conduct + +## 1. Purpose + +A primary goal of Hapi is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof). + +This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior. + +We invite all those who participate in Hapi to help us create safe and positive experiences for everyone. + +## 2. Open [Source/Culture/Tech] Citizenship + +A supplemental goal of this Code of Conduct is to increase open [source/culture/tech] citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community. + +Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society. + +If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know. + +## 3. Expected Behavior + +The following behaviors are expected and requested of all community members: + + * Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community. + * Exercise consideration and respect in your speech and actions. + * Attempt collaboration before conflict. + * Refrain from demeaning, discriminatory, or harassing behavior and speech. + * Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential. + * Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations. + +## 4. Unacceptable Behavior + +The following behaviors are considered harassment and are unacceptable within our community: + + * Violence, threats of violence or violent language directed against another person. + * Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language. + * Posting or displaying sexually explicit or violent material. + * Posting or threatening to post other people's personally identifying information ("doxing"). + * Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability. + * Inappropriate photography or recording. + * Inappropriate physical contact. You should have someone's consent before touching them. + * Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances. + * Deliberate intimidation, stalking or following (online or in person). + * Advocating for, or encouraging, any of the above behavior. + * Sustained disruption of community events, including talks and presentations. + +## 5. Weapons Policy + +No weapons will be allowed at Hapi events, community spaces, or in other spaces covered by the scope of this Code of Conduct. Weapons include but are not limited to guns, explosives (including fireworks), and large knives such as those used for hunting or display, as well as any other item used for the purpose of causing injury or harm to others. Anyone seen in possession of one of these items will be asked to leave immediately, and will only be allowed to return without the weapon. Community members are further expected to comply with all state and local laws on this matter. + +## 6. Consequences of Unacceptable Behavior + +Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated. + +Anyone asked to stop unacceptable behavior is expected to comply immediately. + +If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event). + +## 7. Reporting Guidelines + +If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. . + + + +Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress. + +## 8. Addressing Grievances + +If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies. + + + +## 9. Scope + +We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues--online and in-person--as well as in all one-on-one communications pertaining to community business. + +This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has the potential to adversely affect the safety and well-being of community members. + +## 10. Contact info + + + +## 11. License and attribution + +The Citizen Code of Conduct is distributed by [Stumptown Syndicate](http://stumptownsyndicate.org) under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/). + +Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy). + +_Revision 2.3. Posted 6 March 2017._ + +_Revision 2.2. Posted 4 February 2016._ + +_Revision 2.1. Posted 23 June 2014._ + +_Revision 2.0, adopted by the [Stumptown Syndicate](http://stumptownsyndicate.org) board on 10 January 2013. Posted 17 March 2013._ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b789a17 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,92 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Ensure any install or build dependencies are removed before the end of the layer when doing a + build. +2. Update the README.md with details of changes to the interface, this includes new environment + variables, exposed ports, useful file locations and container parameters. +3. Increase the version numbers in any examples files and the README.md to the new version that this + Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). +4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you + do not have permission to do that, you may request the second reviewer to merge it for you. + +## Code of Conduct + +### Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +### Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +### Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers 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, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +### Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +### Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at [INSERT EMAIL ADDRESS]. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/HISTORY.rst b/HISTORY.rst new file mode 100644 index 0000000..6d1179f --- /dev/null +++ b/HISTORY.rst @@ -0,0 +1,8 @@ +======= +History +======= + +0.1.0 (2022-05-24) +------------------ + +* First release on PyPI. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..2fb2e74 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/README.md b/README.md index 9080518..98b2dfb 100644 --- a/README.md +++ b/README.md @@ -1 +1,65 @@ -# earthobserve \ No newline at end of file +[![Python Versions](https://img.shields.io/pypi/pyversions/earthobserve.png)](https://img.shields.io/pypi/pyversions/earthobserve) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) +[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) +[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/MAfarrag/Hapi.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/MAfarrag/Hapi/context:python) + + + +![GitHub last commit](https://img.shields.io/github/last-commit/MAfarrag/earthobserve) +![GitHub forks](https://img.shields.io/github/forks/MAfarrag/earthobserve?style=social) +![GitHub Repo stars](https://img.shields.io/github/stars/MAfarrag/earthobserve?style=social) + + + +earthobserve - Remote Sensing package +===================================================================== +**earthobserve** is a Remote Sensing package + +earthobserve + +Main Features +------------- + - + + +Future work +------------- + - + + + +Installing earthobserve +=============== + +Installing `earthobserve` from the `conda-forge` channel can be achieved by: + +``` +conda install -c conda-forge earthobserve +``` + +It is possible to list all of the versions of `earthobserve` available on your platform with: + +``` +conda search earthobserve --channel conda-forge +``` + +## Install from Github +to install the last development to time you can install the library from github +``` +pip install git+https://github.com/MAfarrag/earthobserve +``` + +## pip +to install the last release you can easly use pip +``` +pip install earthobserve==0.1.0 +``` + +Quick start +=========== + +``` + >>> import earthobserve +``` + +[other code samples](https://earthobserve.readthedocs.io/en/latest/?badge=latest) diff --git a/clone.json b/clone.json new file mode 100644 index 0000000..ed40d55 --- /dev/null +++ b/clone.json @@ -0,0 +1,4 @@ +{ + "message": "Must have push access to repository", + "documentation_url": "https://docs.github.com/rest/reference/repos#get-repository-clones" +} diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..bb14dd7 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,282 @@ +# +# sphinx-quickstart on Wed April 23 2021. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# General information about the project. +project = u"pyramids" +author = "Mostafa Farrag" + +# copyright = u"2013-2019, " + + +import os +import sys + +# import sphinx_rtd_theme + +html_theme = "sphinxdoc" +# html_theme = "agogo" +html_theme_path = ["."] + + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("../pyramids")) +sys.path.insert(0, os.path.abspath("..")) +sys.path.insert(0, os.path.abspath("../examples")) + +# If your extensions are in another directory, add it here. If the +# directory is relative to the documentation root, use +# os.path.abspath to make it absolute, like shown here. +sys.path.append(os.path.abspath("sphinxext")) + +# import pyramids + + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + "matplotlib.sphinxext.plot_directive", + "sphinx.ext.todo", + "sphinx.ext.mathjax", + "sphinx.ext.autodoc", + "sphinx.ext.graphviz", + "sphinx.ext.doctest", + "sphinx.ext.autosectionlabel", +] + +autosectionlabel_prefix_document = True + +todo_include_todos = True +# Add any paths that contain templates here, relative to this directory. +templates_path = ["templates"] + +# The suffix of source filenames. +source_suffix = ".rst" + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = "index" + + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["build"] + +# The reST default role (used for this markup: `text`) to use for all documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "sphinx_rtd_theme" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +""" +html_logo = "images/pyramids.png" +""" +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["static"] +# +# html_context = { +# 'css_files': [ +# '_static/theme_overrides.css', # override wide tables in RTD theme +# ], +# } + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +html_file_suffix = ".html" + +# Output file base name for HTML help builder. +htmlhelp_basename = "pyramidsdoc" + + +# -- Options for LaTeX output -------------------------------------------------- + + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ("index", "pyramids.tex", u"pyramids Documentation", u"Mostafa Farrag", "report") +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = "_static/logo.png" + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +latex_use_parts = False + +# If true, show page references after internal links. +latex_show_pagerefs = False + +# If true, show URL addresses after external links. +latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +latex_domain_indices = False + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [("index", "pyramids", "pyramids Documentation", [author], 1)] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + "index", + "pyramids", + u"pyramids Documentation", + u"Mostafa Farrag", + "pyramids", + "One line description of project.", + "Miscellaneous", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +autodoc_mock_imports = [ + # "osgeo.gdal", + # "osgeo.gdalconst", + # "osgeo", + # "osgeo.ogr", + # "cftime", + # "xarray", + # "netCDF4", + # "netCDF4_utils", + # "netcdftime", + # "pyproj", + # "pyramids.version", +] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..13cf3a1 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,91 @@ + +Current release info +==================== + +.. image:: https://img.shields.io/pypi/v/pyramids-gis + :target: https://pypi.org/project/pyramids-gis/0.1.0/ + + +.. image:: https://img.shields.io/conda/v/conda-forge/hapi?label=conda-forge + :target: https://pypi.org/project/pyramids-gis/0.1.0/ + + +.. image:: https://img.shields.io/pypi/pyversions/pyramids-gis + :target: https://pypi.org/project/pyramids-gis/0.1.0/ + + +.. image:: https://img.shields.io/github/forks/mafarrag/hapi?style=social :alt: GitHub forks + + +.. image:: https://anaconda.org/conda-forge/hapi/badges/downloads.svg + :target: https://anaconda.org/conda-forge/hapi + + +.. image:: https://img.shields.io/conda/vn/conda-forge/hapi :alt: Conda (channel only) + :target: https://pypi.org/project/pyramids-gis/0.1.0/ + + +.. image:: https://img.shields.io/gitter/room/mafarrag/Hapi + :alt: Gitter + + +.. image:: https://static.pepy.tech/personalized-badge/pyramids-gis?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads + :target: https://pypi.org/project/pyramids-gis/0.1.0/ + + +.. image:: https://img.shields.io/pypi/v/pyramids-gis + :alt: PyPI + + +.. image:: https://anaconda.org/conda-forge/hapi/badges/platforms.svg + :target: https://anaconda.org/conda-forge/hapi + + +.. image:: https://static.pepy.tech/personalized-badge/pyramids-gis?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads + :target: https://pepy.tech/project/pyramids-gis + + + +.. image:: https://static.pepy.tech/personalized-badge/pyramids-gis?period=month&units=international_system&left_color=grey&right_color=blue&left_text=Downloads + :target: https://pepy.tech/project/pyramids-gis + + +.. image:: https://static.pepy.tech/personalized-badge/pyramids-gis?period=week&units=international_system&left_color=grey&right_color=blue&left_text=Downloads + :target: https://pepy.tech/project/pyramids-gis + + + + +pyramids - GIS utility package +===================================================================== + + +**pyramids** is a Python package providing fast and flexible way to build Hydrological models with different spatial +representations (lumped, semidistributed and conceptual distributed) using HBV96. +The package is very flexible to an extent that it allows developers to change the structure of the defined conceptual model or to enter +their own model, it contains two routing functions muskingum cunge, and MAXBAS triangular function. + + +Main Features +------------- +- Modified version of HBV96 hydrological model (Bergström, 1992) with 15 parameters in case of considering + snow processes, and 10 parameters without snow, in addition to 2 parameters of Muskingum routing method +- GIS modules to enable the modeler to fully prepare the meteorological inputs and do all the preprocessing + needed to build the model (align rasters with the DEM), in addition to various methods to manipulate and + convert different forms of distributed data (rasters, NetCDF, shapefiles) +- Visualization module for animating the results of the distributed model, and the meteorological inputs + +.. digraph:: Linking + + GIS -> raster; + GIS -> vector; + GIS -> giscatchment; + dpi=200; + +.. toctree:: + :hidden: + :maxdepth: 1 + + Installation <00Installation.rst> + Tutorial <03tutorial.rst> + GIS <05GIS.rst> diff --git a/earthobserve/__init__.py b/earthobserve/__init__.py new file mode 100644 index 0000000..6a59de3 --- /dev/null +++ b/earthobserve/__init__.py @@ -0,0 +1,36 @@ +try: + from importlib.metadata import PackageNotFoundError # type: ignore + from importlib.metadata import version +except ImportError: # pragma: no cover + from importlib_metadata import PackageNotFoundError # type: ignore + from importlib_metadata import version + + +try: + __version__ = version(__name__) +except PackageNotFoundError: # pragma: no cover + __version__ = "unknown" + +# documentation format +__author__ = "Mostafa Farrag" +__email__ = 'moah.farag@gmail.com' +__docformat__ = "restructuredtext" + +# Let users know if they're missing any of our hard dependencies +hard_dependencies = () # ("numpy", "pandas", "gdal") +missing_dependencies = [] + +for dependency in hard_dependencies: + try: + __import__(dependency) + except ImportError as e: + missing_dependencies.append(dependency) + +if missing_dependencies: + raise ImportError("Missing required dependencies {0}".format(missing_dependencies)) + +import earthobserve.remotesensing as remotesensing + +__doc__ = """ +earthobserve - remote sensing package +""" diff --git a/earthobserve/remotesensing.py b/earthobserve/remotesensing.py new file mode 100644 index 0000000..275db74 --- /dev/null +++ b/earthobserve/remotesensing.py @@ -0,0 +1,981 @@ +""" +Created on Fri Apr 2 06:58:20 2021 + +@author: mofarrag +""" +import calendar +import datetime as dt +import os +from ftplib import FTP +import gzip + +import numpy as np +import pandas as pd +from ecmwfapi import ECMWFDataServer +from joblib import Parallel, delayed +from netCDF4 import Dataset +from osgeo import gdal +import Hapi.weirdFn as weirdFn +from pyramids.raster import Raster + + +class RemoteSensing: + """RemoteSensing. + + RemoteSensing class contains methods to download ECMWF data + + Methods: + 1- main + 2- DownloadData + 3- API + 4- ListAttributes + """ + def __init__( + self, + Time="daily", + start="", + end="", + Path="", + Vars=[], + latlim=[], + lonlim=[], + fmt="%Y-%m-%d", + ): + """ + RemoteSensing(self, Time='daily', start='', end='',Path='', + Vars=[], latlim=[], lonlim=[], fmt="%Y-%m-%d") + + Parameters: + Time (str, optional): + [description]. Defaults to 'daily'. + start (str, optional): + [description]. Defaults to ''. + end (str, optional): + [description]. Defaults to ''. + Path (str, optional): + Path where you want to save the downloaded data. Defaults to ''. + Vars (list, optional): + Variable code: VariablesInfo('day').descriptions.keys(). Defaults to []. + latlim (list, optional): + [ymin, ymax]. Defaults to []. + lonlim (list, optional): + [xmin, xmax]. Defaults to []. + fmt (str, optional): + [description]. Defaults to "%Y-%m-%d". + """ + self.start = dt.datetime.strptime(start, fmt) + self.end = dt.datetime.strptime(end, fmt) + + if Time == "six_hourly": + # Set required data for the three hourly option + self.string1 = "oper" + # Set required data for the daily option + elif Time == "daily": + self.Dates = pd.date_range(self.start, self.end, freq="D") + elif Time == "monthly": + self.Dates = pd.date_range(self.start, self.end, freq="MS") + + self.Time = Time + self.Path = Path + self.Vars = Vars + + # correct latitude and longitude limits + latlim_corr_one = np.floor(latlim[0] / 0.125) * 0.125 + latlim_corr_two = np.ceil(latlim[1] / 0.125) * 0.125 + self.latlim_corr = [latlim_corr_one, latlim_corr_two] + + # correct latitude and longitude limits + lonlim_corr_one = np.floor(lonlim[0] / 0.125) * 0.125 + lonlim_corr_two = np.ceil(lonlim[1] / 0.125) * 0.125 + self.lonlim_corr = [lonlim_corr_one, lonlim_corr_two] + # TODO move it to the ECMWF method later + # for ECMWF only + self.string7 = "%s/to/%s" % (self.start, self.end) + + + def ECMWF(self, Waitbar: bool = True): + """ECMWF + + ECMWF method downloads ECMWF daily data for a given variable, time + interval, and spatial extent. + + + Parameters + ---------- + Waitbar : TYPE, optional + 0 or 1. to display the progress bar + + Returns + ------- + None. + """ + for var in self.Vars: + # Download data + print(f"\nDownload ECMWF {var} data for period {self.start} till {self.end}") + + self.DownloadData(var, Waitbar) # CaseParameters=[SumMean, Min, Max] + # delete the downloaded netcdf + del_ecmwf_dataset = os.path.join(self.Path, "data_interim.nc") + os.remove(del_ecmwf_dataset) + + + def DownloadData(self, Var: str, Waitbar: bool): + """ + This function downloads ECMWF six-hourly, daily or monthly data + + Parameters + ---------- + Var: [str] + + """ + # Load factors / unit / type of variables / accounts + VarInfo = Variables(self.Time) + Varname_dir = VarInfo.file_name[Var] + + # Create Out directory + out_dir = os.path.join(self.Path, self.Time, Varname_dir) + + if not os.path.exists(out_dir): + os.makedirs(out_dir) + + DownloadType = VarInfo.DownloadType[Var] + + if DownloadType == 1: + string1 = "oper" + string4 = "0" + string6 = "00:00:00/06:00:00/12:00:00/18:00:00" + string2 = "sfc" + string8 = "an" + + if DownloadType == 2: + string1 = "oper" + string4 = "12" + string6 = "00:00:00/12:00:00" + string2 = "sfc" + string8 = "fc" + + if DownloadType == 3: + string1 = "oper" + string4 = "0" + string6 = "00:00:00/06:00:00/12:00:00/18:00:00" + string2 = "pl" + string8 = "an" + + parameter_number = VarInfo.number_para[Var] + + string3 = "%03d.128" % (parameter_number) + string5 = "0.125/0.125" + string9 = "ei" + string10 = "%s/%s/%s/%s" % ( + self.latlim_corr[1], + self.lonlim_corr[0], + self.latlim_corr[0], + self.lonlim_corr[1], + ) # N, W, S, E + + # Download data by using the ECMWF API + print("Use API ECMWF to collect the data, please wait") + RemoteSensing.API( + self.Path, + DownloadType, + string1, + string2, + string3, + string4, + string5, + string6, + self.string7, + string8, + string9, + string10, + ) + + # Open the downloaded data + NC_filename = os.path.join(self.Path, "data_interim.nc") + fh = Dataset(NC_filename, mode="r") + + # Get the NC variable parameter + parameter_var = VarInfo.var_name[Var] + Var_unit = VarInfo.units[Var] + factors_add = VarInfo.factors_add[Var] + factors_mul = VarInfo.factors_mul[Var] + + # Open the NC data + Data = fh.variables[parameter_var][:] + Data_time = fh.variables["time"][:] + lons = fh.variables["longitude"][:] + lats = fh.variables["latitude"][:] + + # Define the georeference information + Geo_four = np.nanmax(lats) + Geo_one = np.nanmin(lons) + Geo_out = tuple([Geo_one, 0.125, 0.0, Geo_four, 0.0, -0.125]) + + # Create Waitbar + if Waitbar: + total_amount = len(self.Dates) + amount = 0 + weirdFn.printWaitBar( + amount, total_amount, prefix="Progress:", suffix="Complete", length=50 + ) + + for date in self.Dates: + + # Define the year, month and day + year = date.year + month = date.month + day = date.day + + # Hours since 1900-01-01 + start = dt.datetime(year=1900, month=1, day=1) + end = dt.datetime(year, month, day) + diff = end - start + hours_from_start_begin = diff.total_seconds() / 60 / 60 + + Date_good = np.zeros(len(Data_time)) + + if self.Time == "daily": + days_later = 1 + if self.Time == "monthly": + days_later = calendar.monthrange(year, month)[1] + + Date_good[ + np.logical_and( + Data_time >= hours_from_start_begin, + Data_time < (hours_from_start_begin + 24 * days_later), + ) + ] = 1 + + Data_one = np.zeros( + [int(np.sum(Date_good)), int(np.size(Data, 1)), int(np.size(Data, 2))] + ) + Data_one = Data[np.int_(Date_good) == 1, :, :] + + # Calculate the average temperature in celcius degrees + Data_end = factors_mul * np.nanmean(Data_one, 0) + factors_add + + if VarInfo.types[Var] == "flux": + Data_end = Data_end * days_later + + VarOutputname = VarInfo.file_name[Var] + + # Define the out name + name_out = os.path.join( + out_dir, + "%s_ECMWF_ERA-Interim_%s_%s_%d.%02d.%02d.tif" + % (VarOutputname, Var_unit, self.Time, year, month, day), + ) + + # Create Tiff files + # Raster.Save_as_tiff(name_out, Data_end, Geo_out, "WGS84") + Raster.createRaster(path=name_out, arr=Data_end, geo=Geo_out, epsg="WGS84") + + if Waitbar == 1: + amount = amount + 1 + weirdFn.printWaitBar( + amount, + total_amount, + prefix="Progress:", + suffix="Complete", + length=50, + ) + + fh.close() + + return () + + + @staticmethod + def API( + output_folder, + DownloadType, + string1, + string2, + string3, + string4, + string5, + string6, + string7, + string8, + string9, + string10, + ): + + os.chdir(output_folder) + server = ECMWFDataServer() + + if DownloadType == 1 or DownloadType == 2: + server.retrieve( + { + "stream": "%s" % string1, + "levtype": "%s" % string2, + "param": "%s" % string3, + "dataset": "interim", + "step": "%s" % string4, + "grid": "%s" % string5, + "time": "%s" % string6, + "date": "%s" % string7, + "type": "%s" + % string8, # http://apps.ecmwf.int/codes/grib/format/mars/type/ + "class": "%s" + % string9, # http://apps.ecmwf.int/codes/grib/format/mars/class/ + "area": "%s" % string10, + "format": "netcdf", + "target": "data_interim.nc", + } + ) + + if DownloadType == 3: + server.retrieve( + { + "levelist": "1000", + "stream": "%s" % string1, + "levtype": "%s" % string2, + "param": "%s" % string3, + "dataset": "interim", + "step": "%s" % string4, + "grid": "%s" % string5, + "time": "%s" % string6, + "date": "%s" % string7, + "type": "%s" + % string8, # http://apps.ecmwf.int/codes/grib/format/mars/type/ + "class": "%s" + % string9, # http://apps.ecmwf.int/codes/grib/format/mars/class/ + "area": "%s" % string10, + "format": "netcdf", + "target": "data_interim.nc", + } + ) + + return () + + + @staticmethod + def ExtractFromGZ(InputFile, OutputFile, delete=False): + """ + ExtractFromGZ method extract data from the zip/.gz files, + save the data + + Parameters + ---------- + zip_filename : [str] + zipped file name . + outfilename : [str] + directory where the unzipped data must be + stored. + delete : [bool] + True if you want to delete the zipped file after the extracting the data + Returns + ------- + None. + """ + with gzip.GzipFile(InputFile, "rb") as zf: + content = zf.read() + save_file_content = open(OutputFile, "wb") + save_file_content.write(content) + + save_file_content.close() + zf.close() + + if delete: + os.remove(InputFile) + +class Variables: + """ + This class contains the information about the ECMWF variables + http://rda.ucar.edu/cgi-bin/transform?xml=/metadata/ParameterTables/WMO_GRIB1.98-0.128.xml&view=gribdoc + """ + + number_para = { + "T": 130, + "2T": 167, + "SRO": 8, + "SSRO": 9, + "WIND": 10, + "10SI": 207, + "SP": 134, + "Q": 133, + "SSR": 176, + "R": 157, + "E": 182, + "SUND": 189, + "RO": 205, + "TP": 228, + "10U": 165, + "10V": 166, + "2D": 168, + "SR": 173, + "AL": 174, + "HCC": 188, + } + + var_name = { + "T": "t", + "2T": "t2m", + "SRO": "sro", + "SSRO": "ssro", + "WIND": "wind", + "10SI": "10si", + "SP": "sp", + "Q": "q", + "SSR": "ssr", + "R": "r", + "E": "e", + "SUND": "sund", + "RO": "ro", + "TP": "tp", + "10U": "u10", + "10V": "v10", + "2D": "d2m", + "SR": "sr", + "AL": "al", + "HCC": "hcc", + } + + # ECMWF data + descriptions = { + "T": "Temperature [K]", + "2T": "2 meter Temperature [K]", + "SRO": "Surface Runoff [m]", + "SSRO": "Sub-surface Runoff [m]", + "WIND": "Wind speed [m s-1]", + "10SI": "10 metre windspeed [m s-1]", + "SP": "Surface Pressure [pa]", + "Q": "Specific humidity [kg kg-1]", + "SSR": "Surface solar radiation [W m-2 s]", + "R": "Relative humidity [%]", + "E": "Evaporation [m of water]", + "SUND": "Sunshine duration [s]", + "RO": "Runoff [m]", + "TP": "Total Precipitation [m]", + "10U": "10 metre U wind component [m s-1]", + "10V": "10 metre V wind component [m s-1]", + "2D": "2 metre dewpoint temperature [K]", + "SR": "Surface roughness [m]", + "AL": "Albedo []", + "HCC": "High cloud cover []", + } + + # Factor add to get output + factors_add = { + "T": -273.15, + "2T": -273.15, + "SRO": 0, + "SSRO": 0, + "WIND": 0, + "10SI": 0, + "SP": 0, + "Q": 0, + "SSR": 0, + "R": 0, + "E": 0, + "SUND": 0, + "RO": 0, + "TP": 0, + "10U": 0, + "10V": 0, + "2D": -273.15, + "SR": 0, + "AL": 0, + "HCC": 0, + } + + # Factor multiply to get output + factors_mul = { + "T": 1, + "2T": 1, + "SRO": 1000, + "SSRO": 1000, + "WIND": 1, + "10SI": 1, + "SP": 0.001, + "Q": 1, + "SSR": 1, + "R": 1, + "E": 1000, + "SUND": 1, + "RO": 1000, + "TP": 1000, + "10U": 1, + "10V": 1, + "2D": 1, + "SR": 1, + "AL": 1, + "HCC": 1, + } + + types = { + "T": "state", + "2T": "state", + "SRO": "flux", + "SSRO": "flux", + "WIND": "state", + "10SI": "state", + "SP": "state", + "Q": "state", + "SSR": "state", + "R": "state", + "E": "flux", + "SUND": "flux", + "RO": "flux", + "TP": "flux", + "10U": "state", + "10V": "state", + "2D": "state", + "SR": "state", + "AL": "state", + "HCC": "state", + } + + file_name = { + "T": "Tair2m", + "2T": "Tair", + "SRO": "Surf_Runoff", + "SSRO": "Subsurf_Runoff", + "WIND": "Wind", + "10SI": "Wind10m", + "SP": "Psurf", + "Q": "Qair", + "SSR": "SWnet", + "R": "RelQair", + "E": "Evaporation", + "SUND": "SunDur", + "RO": "Runoff", + "TP": "P", + "10U": "Wind_U", + "10V": "Wind_V", + "2D": "Dewpoint2m", + "SR": "SurfRoughness", + "AL": "Albedo", + "HCC": "HighCloudCover", + } + + DownloadType = { + "T": 3, + "2T": 1, + "SRO": 0, + "SSRO": 0, + "WIND": 0, + "10SI": 0, + "SP": 1, + "Q": 3, + "SSR": 2, + "R": 3, + "E": 2, + "SUND": 2, + "RO": 2, + "TP": 2, + "10U": 1, + "10V": 1, + "2D": 1, + "SR": 1, + "AL": 1, + "HCC": 1, + } + + + def __init__(self, step): + + # output units after applying factor + if step == "six_hourly": + self.units = { + "T": "C", + "2T": "C", + "SRO": "mm", + "SSRO": "mm", + "WIND": "m_s-1", + "10SI": "m_s-1", + "SP": "kpa", + "Q": "kg_kg-1", + "SSR": "W_m-2_s", + "R": "percentage", + "E": "mm", + "SUND": "s", + "RO": "mm", + "TP": "mm", + "10U": "m_s-1", + "10V": "m_s-1", + "2D": "C", + "SR": "m", + "AL": "-", + "HCC": "-", + } + + elif step == "daily": + self.units = { + "T": "C", + "2T": "C", + "SRO": "mm", + "SSRO": "mm", + "WIND": "m_s-1", + "10SI": "m_s-1", + "SP": "kpa", + "Q": "kg_kg-1", + "SSR": "W_m-2_s", + "R": "percentage", + "E": "mm", + "SUND": "s", + "RO": "mm", + "TP": "mm", + "10U": "m_s-1", + "10V": "m_s-1", + "2D": "C", + "SR": "m", + "AL": "-", + "HCC": "-", + } + + elif step == "monthly": + self.units = { + "T": "C", + "2T": "C", + "SRO": "mm", + "SSRO": "mm", + "WIND": "m_s-1", + "10SI": "m_s-1", + "SP": "kpa", + "Q": "kg_kg-1", + "SSR": "W_m-2_s", + "R": "percentage", + "E": "mm", + "SUND": "s", + "RO": "mm", + "TP": "mm", + "10U": "m_s-1", + "10V": "m_s-1", + "2D": "C", + "SR": "m", + "AL": "-", + "HCC": "-", + } + + else: + raise KeyError("The input time step is not supported") + + + def __str__(self): + + print( + "Variable name:" + + "\n" + + str(self.var_name) + + "\n" + + "Descriptions" + + "\n" + + str(self.descriptions) + + "\n" + + "Units : " + + "\n" + + str(self.units) + ) + + + def ListAttributes(self): + """ + Print Attributes List + """ + + print("\n") + print( + "Attributes List of: " + + repr(self.__dict__["name"]) + + " - " + + self.__class__.__name__ + + " Instance\n" + ) + self_keys = list(self.__dict__.keys()) + self_keys.sort() + for key in self_keys: + if key != "name": + print(str(key) + " : " + repr(self.__dict__[key])) + + print("\n") + + +class CHIRPS: + + + def __init__( + self, + start="", + end="", + latlim=[], + lonlim=[], + Time="daily", + Path="", + fmt="%Y-%m-%d", + ): + # latlim -- [ymin, ymax] (values must be between -50 and 50) + # lonlim -- [xmin, xmax] (values must be between -180 and 180) + # TimeCase -- String equal to 'daily' or 'monthly' + + # Define timestep for the timedates + if Time == "daily": + self.TimeFreq = "D" + self.output_folder = os.path.join(Path, "Precipitation", "CHIRPS", "Daily") + elif Time == "monthly": + self.TimeFreq = "MS" + self.output_folder = os.path.join( + Path, "Precipitation", "CHIRPS", "Monthly" + ) + else: + raise KeyError("The input time interval is not supported") + self.Time = Time + + # make directory if it not exists + if not os.path.exists(self.output_folder): + os.makedirs(self.output_folder) + + # check time variables + if start == "": + start = pd.Timestamp("1981-01-01") + else: + self.start = dt.datetime.strptime(start, fmt) + + if end == "": + end = pd.Timestamp("Now") + else: + self.end = dt.datetime.strptisme(end, fmt) + # Create days + self.Dates = pd.date_range(self.start, self.end, freq=self.TimeFreq) + + # Check space variables + if latlim[0] < -50 or latlim[1] > 50: + print( + "Latitude above 50N or below 50S is not possible." + " Value set to maximum" + ) + self.latlim[0] = np.max(latlim[0], -50) + self.latlim[1] = np.min(lonlim[1], 50) + if lonlim[0] < -180 or lonlim[1] > 180: + print( + "Longitude must be between 180E and 180W." + " Now value is set to maximum" + ) + self.lonlim[0] = np.max(latlim[0], -180) + self.lonlim[1] = np.min(lonlim[1], 180) + else: + self.latlim = latlim + self.lonlim = lonlim + # Define IDs + self.yID = 2000 - np.int16( + np.array([np.ceil((latlim[1] + 50) * 20), np.floor((latlim[0] + 50) * 20)]) + ) + self.xID = np.int16( + np.array( + [np.floor((lonlim[0] + 180) * 20), np.ceil((lonlim[1] + 180) * 20)] + ) + ) + + + def Download(self, Waitbar=1, cores=None): + """ + ============================================================ + Download(self, Waitbar=1, cores=None) + ============================================================ + Download method downloads CHIRPS data + + Parameters + ---------- + Waitbar : TYPE, optional + will print a waitbar. The default is 1. + cores : TYPE, optional + The number of cores used to run the routine. It can be 'False' + to avoid using parallel computing routines. The default is None. + + Returns + ------- + results : TYPE + DESCRIPTION. + + """ + # Pass variables to parallel function and run + args = [ + self.output_folder, + self.Time, + self.xID, + self.yID, + self.lonlim, + self.latlim, + ] + + if not cores: + # Create Waitbar + if Waitbar == 1: + total_amount = len(self.Dates) + amount = 0 + weirdFn.printWaitBar( + amount, + total_amount, + prefix="Progress:", + suffix="Complete", + length=50, + ) + + for Date in self.Dates: + CHIRPS.RetrieveData(Date, args) + if Waitbar == 1: + amount = amount + 1 + weirdFn.printWaitBar( + amount, + total_amount, + prefix="Progress:", + suffix="Complete", + length=50, + ) + results = True + else: + results = Parallel(n_jobs=cores)( + delayed(CHIRPS.RetrieveData)(Date, args) for Date in self.Dates + ) + return results + + + def RetrieveData(Date, args): + """ + =============================================== + RetrieveData(Date, args) + =============================================== + RetrieveData method retrieves CHIRPS data for a given date from the + https://data.chc.ucsb.edu/ + + Parameters + ---------- + Date : TYPE + DESCRIPTION. + args : TYPE + A list of parameters defined in the DownloadData function. + + Raises + ------ + KeyError + DESCRIPTION. + + Returns + ------- + bool + DESCRIPTION. + + """ + # Argument + [output_folder, TimeCase, xID, yID, lonlim, latlim] = args + + # open ftp server + # ftp = FTP("chg-ftpout.geog.ucsb.edu", "", "") + ftp = FTP("data.chc.ucsb.edu") + ftp.login() + + # Define FTP path to directory + if TimeCase == "daily": + pathFTP = ( + "pub/org/chg/products/CHIRPS-2.0/global_daily/tifs/p05/%s/" + % Date.strftime("%Y") + ) + elif TimeCase == "monthly": + pathFTP = "pub/org/chg/products/CHIRPS-2.0/global_monthly/tifs/" + else: + raise KeyError("The input time interval is not supported") + + # find the document name in this directory + ftp.cwd(pathFTP) + listing = [] + + # read all the file names in the directory + ftp.retrlines("LIST", listing.append) + + # create all the input name (filename) and output (outfilename, filetif, DiFileEnd) names + if TimeCase == "daily": + filename = "chirps-v2.0.%s.%02s.%02s.tif.gz" % ( + Date.strftime("%Y"), + Date.strftime("%m"), + Date.strftime("%d"), + ) + outfilename = os.path.join( + output_folder, + "chirps-v2.0.%s.%02s.%02s.tif" + % (Date.strftime("%Y"), Date.strftime("%m"), Date.strftime("%d")), + ) + DirFileEnd = os.path.join( + output_folder, + "P_CHIRPS.v2.0_mm-day-1_daily_%s.%02s.%02s.tif" + % (Date.strftime("%Y"), Date.strftime("%m"), Date.strftime("%d")), + ) + elif TimeCase == "monthly": + filename = "chirps-v2.0.%s.%02s.tif.gz" % ( + Date.strftime("%Y"), + Date.strftime("%m"), + ) + outfilename = os.path.join( + output_folder, + "chirps-v2.0.%s.%02s.tif" % (Date.strftime("%Y"), Date.strftime("%m")), + ) + DirFileEnd = os.path.join( + output_folder, + "P_CHIRPS.v2.0_mm-month-1_monthly_%s.%02s.%02s.tif" + % (Date.strftime("%Y"), Date.strftime("%m"), Date.strftime("%d")), + ) + else: + raise KeyError("The input time interval is not supported") + + # download the global rainfall file + try: + local_filename = os.path.join(output_folder, filename) + lf = open(local_filename, "wb") + ftp.retrbinary("RETR " + filename, lf.write, 8192) + lf.close() + + # unzip the file + zip_filename = os.path.join(output_folder, filename) + RemoteSensing.ExtractFromGZ(zip_filename, outfilename, delete=True) + + # open tiff file + src = gdal.Open(outfilename) + dataset, NoDataValue = Raster.getRasterData(src) + + # clip dataset to the given extent + data = dataset[yID[0]: yID[1], xID[0]: xID[1]] + # replace -ve values with -9999 + data[data < 0] = -9999 + + # save dataset as geotiff file + geo = [lonlim[0], 0.05, 0, latlim[1], 0, -0.05] + Raster.createRaster( + path=DirFileEnd, + data=data, + geo=geo, + epsg="WGS84", + nodatavalue=NoDataValue, + ) + + # delete old tif file + os.remove(outfilename) + + except: + print("file not exists") + return True + + + def ListAttributes(self): + """ + Print Attributes List + """ + + print("\n") + print( + "Attributes List of: " + + repr(self.__dict__["name"]) + + " - " + + self.__class__.__name__ + + " Instance\n" + ) + self_keys = list(self.__dict__.keys()) + self_keys.sort() + for key in self_keys: + if key != "name": + print(str(key) + " : " + repr(self.__dict__[key])) + + print("\n") + + +# class MSWEP(): +"http://www.gloh2o.org/mswx/" diff --git a/earthobserve/rs/__init__.py b/earthobserve/rs/__init__.py new file mode 100644 index 0000000..dc346d0 --- /dev/null +++ b/earthobserve/rs/__init__.py @@ -0,0 +1,7 @@ +""" +Created on Sat Apr 24 20:57:45 2021 + +@author: mofarrag +""" + + diff --git a/environment.yml b/environment.yml new file mode 100644 index 0000000..81a2b0e --- /dev/null +++ b/environment.yml @@ -0,0 +1,13 @@ +channels: + - conda-forge +dependencies: + - python >=3.7.1,<3.10 + - pip >=21.3.1 + - netCDF4 >=1.5.5,<1.5.9 + - gdal >=3.3.3,<3.5.1 + - pandas >=1.3.2,<1.4.3 + - pip: + - pyramids-gis >=0.1.0 + - loguru >=0.5.3 + - pytest >=6.2.5 + - pytest-cov >=2.12.1 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..b5ed588 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,14 @@ +site_name: statista +site_description: The documentation of Hapi Hydrological Model +site_author: Mostafa Farrag + +repo_url: https://github.com/MAfarrag/statista +edit_url: "" + +theme: + name: readthedocs + +nav: + - Home: index.md + - GIS: GIS.md + - License: license.md diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..f74169c --- /dev/null +++ b/setup.py @@ -0,0 +1,48 @@ +from setuptools import find_packages, setup + +with open("README.md", "r") as readme_file: + readme = readme_file.read() + +with open('HISTORY.rst') as history_file: + history = history_file.read() + +# requirements = [line.strip() for line in open("requirements.txt").readlines()] +# requirements = requirements[1:] + +test_requirements = ['pytest>=3', ] + +setup( + name="earthobserve", + version="0.1.0", + description="remote sensing package", + author="Mostafa Farrag", + author_email="moah.farag@gmail.come", + url="https://github.com/MAfarrag/earthobserve", + keywords=["remote sensing", "ecmwf"], + long_description=readme + '\n\n' + history, + long_description_content_type="text/markdown", + license="GNU General Public License v3", + zip_safe=False, + packages=find_packages(include=['earthobserve', 'earthobserve.*']), + test_suite="tests", + tests_require=test_requirements, + # install_requires=requirements, + entry_points={ + 'console_scripts': [ + 'earthobserve=earthobserve.cli:main', + ], + }, + classifiers=[ + "Development Status :: 5 - Production/Stable", + "Environment :: Console", + 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', + "Natural Language :: English", + 'Programming Language :: Python :: 3', + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Topic :: Scientific/Engineering :: GIS", + "Intended Audience :: Science/Research", + "Intended Audience :: Developers", + ], +) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..9676663 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,30 @@ +from typing import List + +import pandas as pd +import pytest + + +@pytest.fixture(scope="module") +def time_series1() -> list: + return pd.read_csv("examples/data/time_series1.txt", header=None)[0].tolist() + + +@pytest.fixture(scope="module") +def time_series2() -> list: + return pd.read_csv("examples/data/time_series2.txt", header=None)[0].tolist() + +@pytest.fixture(scope="module") +def dist_estimation_parameters() -> List[str]: + return ["mle", "lmoments"] + +@pytest.fixture(scope="module") +def dist_estimation_parameters_ks() -> str: + return "lmoments" + +@pytest.fixture(scope="module") +def confidence_interval_alpha() -> float: + return 0.1 + +@pytest.fixture(scope="module") +def parameter_estimation_optimization_threshold() -> int: + return 17 diff --git a/tests/test_distributions.py b/tests/test_distributions.py new file mode 100644 index 0000000..7a9fdca --- /dev/null +++ b/tests/test_distributions.py @@ -0,0 +1,255 @@ +from typing import List + +import numpy as np +from matplotlib.figure import Figure + +from statista.distributions import GEV, ConfidenceInterval, Gumbel, PlottingPosition + + +def test_plotting_position_weibul( + time_series1: list, +): + cdf = PlottingPosition.Weibul(time_series1, option=1) + assert isinstance(cdf, np.ndarray) + rp = PlottingPosition.Weibul(time_series1, option=2) + assert isinstance(rp, np.ndarray) + +def test_plotting_position_rp( + time_series1: list, +): + cdf = PlottingPosition.Weibul(time_series1, option=1) + rp = PlottingPosition.Returnperiod(cdf) + assert isinstance(rp, np.ndarray) + + +def test_create_gumbel_instance( + time_series1: list, +): + Gdist = Gumbel(time_series1) + assert isinstance(Gdist.data, np.ndarray) + assert isinstance(Gdist.data_sorted, np.ndarray) + + +def test_gumbel_estimate_parameter( + time_series2: list, + dist_estimation_parameters: List[str], +): + Gdist = Gumbel(time_series2) + for i in range(len(dist_estimation_parameters)): + param = Gdist.EstimateParameter(method=dist_estimation_parameters[i], Test=False) + assert isinstance(param, list) + assert Gdist.loc + assert Gdist.scale + + +def test_parameter_estimation_optimization( + time_series2: list, + dist_estimation_parameters: List[str], + parameter_estimation_optimization_threshold: int, +): + Gdist = Gumbel(time_series2) + param = Gdist.EstimateParameter( + method="optimization", ObjFunc=Gumbel.ObjectiveFn, + threshold=parameter_estimation_optimization_threshold + ) + assert isinstance(param, list) + assert Gdist.loc + assert Gdist.scale + +def test_gumbel_ks( + time_series2: list, + dist_estimation_parameters_ks: str, +): + Gdist = Gumbel(time_series2) + Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + Gdist.ks() + assert Gdist.Dstatic + assert Gdist.KS_Pvalue + + + +def test_gumbel_chisquare( + time_series2: list, + dist_estimation_parameters_ks: str, +): + Gdist = Gumbel(time_series2) + Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + Gdist.chisquare() + assert Gdist.chistatic + assert Gdist.chi_Pvalue + + +def test_gumbel_pdf( + time_series2: list, + dist_estimation_parameters_ks: str, +): + Gdist = Gumbel(time_series2) + Param = Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + pdf, fig, ax = Gdist.pdf(Param[0], Param[1], plot_figure=True) + assert isinstance(pdf, np.ndarray) + assert isinstance(fig, Figure) + + +def test_gumbel_cdf( + time_series2: list, + dist_estimation_parameters_ks: str, +): + Gdist = Gumbel(time_series2) + Param = Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + cdf, fig, ax = Gdist.cdf(Param[0], Param[1], plot_figure=True) + assert isinstance(cdf, np.ndarray) + assert isinstance(fig, Figure) + + +def test_gumbel_TheporeticalEstimate( + time_series2: list, + dist_estimation_parameters_ks: str, +): + Gdist = Gumbel(time_series2) + cdf_Weibul = PlottingPosition.Weibul(time_series2) + Param = Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + Qth = Gdist.TheporeticalEstimate(Param[0], Param[1], cdf_Weibul) + assert isinstance(Qth, np.ndarray) + + +def test_gumbel_confidence_interval( + time_series2: list, + dist_estimation_parameters_ks: str, + confidence_interval_alpha: float +): + Gdist = Gumbel(time_series2) + cdf_Weibul = PlottingPosition.Weibul(time_series2) + Param = Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + upper, lower = Gdist.ConfidenceInterval(Param[0], Param[1], cdf_Weibul, alpha=confidence_interval_alpha) + assert isinstance(upper, np.ndarray) + assert isinstance(lower, np.ndarray) + + +def test_gumbel_probapility_plot( + time_series2: list, + dist_estimation_parameters_ks: str, + confidence_interval_alpha: float +): + Gdist = Gumbel(time_series2) + cdf_Weibul = PlottingPosition.Weibul(time_series2) + Param = Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + [fig1, fig2], [ax1, ax2] = Gdist.ProbapilityPlot(Param[0], Param[1], cdf_Weibul, alpha=confidence_interval_alpha) + assert isinstance(fig1, Figure) + assert isinstance(fig2, Figure) + + + + + +def test_create_gev_instance( + time_series1: list, +): + Gdist = GEV(time_series1) + assert isinstance(Gdist.data, np.ndarray) + assert isinstance(Gdist.data_sorted, np.ndarray) + + +def test_gev_estimate_parameter( + time_series1: list, + dist_estimation_parameters: List[str], +): + Gdist = GEV(time_series1) + for i in range(len(dist_estimation_parameters)): + param = Gdist.EstimateParameter(method=dist_estimation_parameters[i], Test=False) + assert isinstance(param, list) + assert Gdist.loc + assert Gdist.scale + assert Gdist.shape + + +def test_gev_ks( + time_series1: list, + dist_estimation_parameters_ks: str, +): + Gdist = GEV(time_series1) + Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + Gdist.ks() + assert Gdist.Dstatic + assert Gdist.KS_Pvalue + +def test_gev_chisquare( + time_series1: list, + dist_estimation_parameters_ks: str, +): + Gdist = GEV(time_series1) + Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + Gdist.chisquare() + assert Gdist.chistatic + assert Gdist.chi_Pvalue + + +def test_gev_pdf( + time_series1: list, + dist_estimation_parameters_ks: str, +): + Gdist = GEV(time_series1) + Param = Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + pdf, fig, ax = Gdist.pdf(Param[0], Param[1], Param[2], plot_figure=True) + assert isinstance(pdf, np.ndarray) + assert isinstance(fig, Figure) + + +def test_gev_cdf( + time_series1: list, + dist_estimation_parameters_ks: str, +): + Gdist = GEV(time_series1) + Param = Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + cdf, fig, ax = Gdist.cdf(Param[0], Param[1], Param[2], plot_figure=True) + assert isinstance(cdf, np.ndarray) + assert isinstance(fig, Figure) + +def test_gev_TheporeticalEstimate( + time_series1: list, + dist_estimation_parameters_ks: str, +): + Gdist = GEV(time_series1) + cdf_Weibul = PlottingPosition.Weibul(time_series1) + Param = Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + Qth = Gdist.TheporeticalEstimate(Param[0], Param[1], Param[2],cdf_Weibul) + assert isinstance(Qth, np.ndarray) + + +def test_gev_confidence_interval( + time_series1: list, + dist_estimation_parameters_ks: str, + confidence_interval_alpha: float +): + Gdist = GEV(time_series1) + cdf_Weibul = PlottingPosition.Weibul(time_series1) + Param = Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + func = ConfidenceInterval.GEVfunc + upper, lower = Gdist.ConfidenceInterval( + Param[0], Param[1], Param[2], F=cdf_Weibul, alpha=confidence_interval_alpha, + statfunction=func, n_samples=len(time_series1) + ) + assert isinstance(upper, np.ndarray) + assert isinstance(lower, np.ndarray) + + +def test_confidence_interval_directly( + time_series1: list, + dist_estimation_parameters_ks: str, + confidence_interval_alpha: float +): + Gdist = GEV(time_series1) + cdf_Weibul = PlottingPosition.Weibul(time_series1) + Param = Gdist.EstimateParameter(method=dist_estimation_parameters_ks, Test=False) + func = ConfidenceInterval.GEVfunc + # upper, lower = Gdist.ConfidenceInterval( + # Param[0], Param[1], Param[2], F=cdf_Weibul, alpha=confidence_interval_alpha, + # statfunction=func, n_samples=len(time_series1) + # ) + CI = ConfidenceInterval.BootStrap( + time_series1, statfunction=func, gevfit=Param, n_samples=len(time_series1), F=cdf_Weibul + ) + LB = CI["LB"] + UB = CI["UB"] + + assert isinstance(LB, np.ndarray) + assert isinstance(UB, np.ndarray)