diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
index 4b7c8e6..9c51aa8 100644
--- a/.github/workflows/gh-pages.yml
+++ b/.github/workflows/gh-pages.yml
@@ -18,6 +18,7 @@ jobs:
- name: Dependencies
run: |
if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi
+ if [ -f pyproject.toml ]; then pip install ".[docs]"; fi
- name: Build Jupyter Book
run: |
jupyter-book build . --config docs/_config.yml --toc docs/_toc.yml
diff --git a/.gitignore b/.gitignore
index 9fe98ba..b0a8e0d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -91,4 +91,4 @@ _build/
# python-dotenv
.env
-/data
\ No newline at end of file
+/data
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..0f77dd2
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,39 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+ - repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: v4.5.0
+ hooks:
+ - id: trailing-whitespace
+ - id: end-of-file-fixer
+ - id: check-yaml
+ - id: check-added-large-files
+ - id: check-ast
+ - id: check-json
+ - id: detect-aws-credentials
+ args: [--allow-missing-credentials]
+ - id: detect-private-key
+ - repo: https://github.com/igorshubovych/markdownlint-cli
+ rev: v0.39.0
+ hooks:
+ - id: markdownlint
+ name: Markdownlint
+ files: \.(md|mdown|markdown)$
+ args: [
+ "--disable=MD013", # line-length
+ "--disable=MD033", # no-inline-html
+ ]
+ - repo: https://github.com/codespell-project/codespell
+ rev: v2.2.6
+ hooks:
+ - id: codespell
+ name: codespell
+ description: Checks for common misspellings in text files
+ - repo: https://github.com/astral-sh/ruff-pre-commit
+ rev: v0.2.1
+ hooks:
+ - id: ruff
+ types_or: [python, pyi, jupyter]
+ args: [--fix]
+ - id: ruff-format
+ types_or: [python, pyi, jupyter]
diff --git a/LICENSE b/LICENSE
index e605458..d0a1fa1 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,541 +1,373 @@
-World Bank Master Community License Agreement
-
-THIS WORLD BANK COMMUNITY LICENSE AGREEMENT ("Agreement") is entered
-between the International Bank for Reconstruction and
-Development/International Development Association ("World Bank")
-and the party identified as licensee on the signature page of this
-Agreement ("Licensee"). Licensee and the World Bank are each referred to
-herein as a "Party" and collectively as, the "Parties".
-
-A. The World Bank has developed that certain computer software
- identified on Exhibit B ("Licensed Software") for use for the
- public good and desire to make the Licensed Software available to
- Licensee on a royalty-free basis, subject to certain other terms and
- conditions.
-
-B. Licensee wishes to secure certain rights to use, modify and
- sublicense the Licensed Software.
-
-NOW, THEREFORE, in consideration of the mutual promises of the Parties
-and other good and valuable consideration, receipt of which is hereby
-acknowledged, the Parties agree as follows:
-
-1. Definitions
-
- 1. **"Contribution"** means any subject matter which is created by
- any person, which subject matter has the effect of adding to,
- deleting from, replacing, or otherwise modifying the text,
- binary or other material in a Core Program, whether deriving
- directly from a Core Program or from Licensed Software. A
- Contribution may be included in the same file as material from a
- Core Program, or in a separate file that is or can be used in
- connection with a compilation, build or similar process to add
- to, delete from, replace or otherwise modify material from the
- file containing Licensed Software.
-
- 2. **"Core Programs"** mean the Computer programs and associated
- data originally created by or for the World Bank as part of the
- Licensed Software and made available by the World Bank or its
- licensees pursuant to the terms equivalent to those of this
- Agreement.
-
- 3. **"Covered Licensee"** has the meaning set forth in Section 2.3.
-
- 4. **"Covered Work"** means any work that includes Licensed
- Software and Independent Software.
-
- 5. **"Distribute"** means, for the purpose of this Agreement, to
- deliver or offer to deliver a copy of a work to a person other
- than to a person controlled by, controlling or under common
- control with the first person or a person engaged solely to
- develop, maintain, test, or operate such work on behalf the
- first person.
-
- 6. **"Exploit"** means in the case of copyrightable subject matter
- to copy, make derivative works, distribute, display, and perform
- such subject matter and any analogous or additional rights
- provided under the laws of any country within the Licensed
- Territory. In the case of patentable subject matter, "Exploit"
- includes the right to make, use, sell, offer for sale, have
- made, import the relevant subject matter. Except as expressly
- provided in this Agreement, the right to Exploit does not
- include the right to authorize others to Exploit the subject
- matter.
-
- 7. **"Independent** **Software"** means any software that does not
- include any Core Programs or Contributions. No software
- contained in the same file as Licensed Software shall be deemed
- Independent Software under the terms of this Agreement.
-
- 8. **"Licensed Software"** means the Core Programs identified on
- Exhibit B hereto, together with any Contributions thereto,
- whether in Source Code or Object Code form.
-
- 9. **"Licensed** **Territory"** has the meaning set forth in
- Section 2.2.
-
- 10. **"Object Code"** means any version of a computer program which
- is capable of being installed, loaded, and operated on a
- computer without any intervening process other than a system
- loader or linkage editor or a real-time interpreter.
-
- 11. **"Source Code"** means any version of a computer program other
- than Object Code, including without limitation any text or
- text-equivalent capable of being compiled or translated into
- Object Code, and any associated documentation in existence that
- is necessary or convenient to compile, modify, edit (including
- without limitation any linkage edit or build process), integrate
- and configure such computer program for installation and/or use.
-
-2. Licenses
-
- 1. **Basic Grant.** Subject to Licensee's compliance with all terms
- and conditions of this Agreement, World Bank grants to Licensee
- the royalty-free, perpetual, non-exclusive right and license to
- Exploit the Licensed Software, whether alone or as part of a
- Covered Work.
-
- 2. **Territorial Limitations.** The rights granted to Licensee
- hereunder only apply to exploitation in the member countries of
- the World Bank ("Licensed Territory").
-
- 3. **Rights in Contributions.** Licensee hereby grants to World
- Bank a paid up, royalty-free, perpetual, irrevocable,
- non-exclusive, sublicenseable right and license to Exploit any
- Contributions created by or for Licensee, effective immediately
- on the first Distribution of any work containing a Contribution.
- Such Contribution shall be thereafter considered part of the
- Licensed Software and authorized for Exploitation by any person
- or entity who has received rights to the Core Software ("Covered
- Licensee").
-
- 4. **Patent Rights.** Licensee further grants to World Bank and all
- other Covered Licensees a paid up, royalty-free, perpetual,
- irrevocable and sublicenseable license to Exploit its
- Contributions or any version of the Licensed Software including
- its Contributions under any patents now or in the future owned
- or licenseable by Licensee, solely to the extent that such
- Exploitation is of a work consisting of Licensed Software and
- Licensee's Contribution.
-
- 5. **Sublicenses.** In the event that Licensee is an entity
- chartered under the laws of a nation state within the Licensed
- Territory, Licensee shall be permitted to grant sublicenses to
- others to Exploit the Licensed Software pursuant to a license
- agreement containing the provisions set forth in Exhibit A
- hereto, as the same may be modified from time to time by the
- World Bank in accordance with this Section. Licensee shall
- maintain a computerized repository from which sublicensees may
- download the Licensed Software, which repository shall require a
- reasonable means by which the Licensee so downloading the code
- may be identified. If practicable, each downloadable copy shall
- be electronically watermarked so as to identify the repository
- from which it has been downloaded. Nothing herein shall be
- deemed to prohibit the restriction or fee-based licensing of
- Covered Works, provided that Licensee and any sublicensees
- comply in full with all requirements for the unrestricted
- further distribution of Licensed Software included within such
- Covered Work. Except as expressly provided in this Section 2.5,
- Licensee shall not grant sublicenses of Licensed Software and/or
- any Contribution to any person.
-
- 6. **Revision of Sublicense Terms.** The World Bank may from time
- to time establish different terms for sublicenses to replace the
- terms of Exhibit A hereto. Such different terms shall apply to
- any sublicenses granted by Licensee pursuant to Section 2.5, on
- ten (10) days notice given to Licensee pursuant to this
- Agreement, by which time Licensee shall have posted the revised
- terms in print (if previously published in print) and any
- electronically accessible location where it has previously
- posted such terms..
-
- 7. **No Personal Use.** Licensee represents and warrants that the
- Licensed Software is not intended to be used and will not be
- used or authorized for use for personal, household and/or family
- uses.
-
-3. Obligations of Licensee
-
- 1. **Distribution of Source Code.** In the event that Licensee
- Distributes any form of the Licensed Software, whether as Source
- Code or Object Code and whether by itself or as part of a
- Covered Work, Licensee shall promptly make available the full
- Source Code of such Licensed Software (including any
- Contributions by Licensee) to all persons on the terms set forth
- in Exhibit A, either by making such Source Code accessible in a
- commonly available online source code repository, an online
- repository under the direct control of Licensee, or by notifying
- such persons that such Source Code may be delivered by
- electronic transmission to any requesting person, at no charge
- other than a reasonable fee covering the cost of distribution to
- the recipient.
-
- 2. **Inclusion of Applicable License Provisions.** Licensee shall
- assure that every copy of Licensed Software (including any such
- copy included in a Covered Work) shall either include the full
- text of the license required by Section 3.2 or a statement that
- identifies a uniform resource locator which contains the
- applicable license.
-
- 3. **No Further Restrictions.** Licensee shall not impose any
- restrictions on the further use, distribution or modification of
- Licensed Software, whether distributed by itself or as part of a
- Covered Work, provided that the License Software is made
- available by Licensee and its sublicensee on terms specified in
- Exhibit A hereto. Nothing herein shall prohibit Licensee from
- imposing any conditions Licensee sees fit on the subsequent
- distribution of Independent Software included in any Covered
- Work.
-
- 4. **Enforcement of Sublicenses.** By accepting this License
- Agreement and a copy of the Licensed Software, Licensee agrees
- that it will take action to enforce the terms of any
- sublicenses, including without limitation seeking injunctive or
- other equitable relief. Licensee shall not, however, name or
- attempt to name the World Bank as an involuntary plaintiff in
- any such action, without the prior written consent of the World
- Bank . No enforcement action shall be required if the World Bank
- is deemed a necessary party plaintiff or defendant and the World
- Bank withholds consent to being so named. In the event that
- Licensee becomes aware of breaches of any of its sublicenses, it
- shall notify the World Bank in writing as soon as practicable
- and, in the event Licensee determines to seek legal relief, it
- shall so notify the World Bank of its intention to pursue such
- legal relief.
-
- 5. **Conditions of License.** Sections 3.1 through 3.4 above are
- conditions of the licenses granted in Article 2 Licensee
- specifically acknowledges that its failure to comply strictly
- with such conditions voids all licenses granted to Licensee
- hereunder, without further notice from World Bank. Sublicenses
- granted by Licensee in accordance with this Agreement shall
- continue in effect, provided that the applicable sublicensees
- comply and continue to comply with all provisions of Exhibit A
- hereto.
-
- 6. **Permitted Arrangements.** Nothing herein shall prohibit
- Licensee (or any sublicensee) from offering and charging for
- warranty, support, indemnity, or liability obligations to one or
- more recipients of Licensed Software or Covered Works, provided
- that Licensee and any applicable sublicensee prominently
- notifies any persons purchasing such additional obligations that
- such obligations are solely the obligations of the persons
- offering such obligations neither World Bank nor any person
- other than the person offering such services is obligated or
- responsible in any way with respect to the Licensed Software or
- any portion thereof.
-
- 7. **Attribution and Disclaimer.** All copies of Licensed Software
- and/or Covered Works Distributed by Licensee and any sublicensee
- deriving from Licensee shall contain a notice that certain
- underlying work was originally developed by or for the World
- Bank, that the World Bank is not responsible for the accuracy,
- other functionality or performance of such Licensed Software
- and/or Covered Work.
-
-4. Warranties by Licensee
-
- 1. **Non-infringement of Copyright.** Licensee hereby represents
- and warrants to World Bank and any persons who are licensees of
- Licensed Software deriving from Core Software that its
- Contributions are and/or will be either its original works of
- authorship or that it has sufficient rights in such
- Contributions to grant the rights required to be granted in such
- Contributions (and derivatives thereof) pursuant to this
- Agreement.
-
- 2. **Patent Warranties.** Licensee hereby represents that, to the
- best of its knowledge, the combination of any Licensed Software
- with a Contribution from Licensee does not infringe the patent
- rights of any third party.
-
- 3. **Disclaimer.** LICENSEE UNDERSTANDS AND AGREES THAT ITS USE
- (INCLUDING WITHOUT LIMITATION, THE EXERCISE OF ANY RIGHTS
- GRANTED TO IT UNDER THIS AGREEMENT) OF THE SOFTWARE IS AT
- LICENSEE'S SOLE RISK. THE SOFTWARE IS PROVIDED ON AN "AS IS" AND
- "AS AVAILABLE" BASIS. THE WORLD BANK DISCLAIMS ALL
- REPRESENTATIONS AND WARRANTIES OF ANY KIND, WHETHER EXPRESS,
- IMPLIED, OR STATUTORY, WITH RESPECT TO THE SOFTWARE (INCLUDING,
- BUT NOT LIMITED TO, THE IMPLIED OR STATUTORY WARRANTIES OF
- MERCHANTABILITY, FITNESS FOR A PARTICULAR USE OR PURPOSE, TITLE,
- QUIET ENJOYMENT, AND NON-INFRINGEMENT. IN PARTICULAR, THE WORLD
- BANK DOES NOT REPRESENT OR WARRANT THAT ANY INFORMATION OR OTHER
- CONTENT OBTAINED OR VIEWED BY LICENSEE OR ANYONE ELSE AS A
- RESULT OF LICENSEE'S EXPLOITATION OF THE SOFTWARE WILL BE
- ACCURATE, COMPLETE OR RELIABLE, THAT LICENSEE'S ACCESS TO THE
- SOFTWARE WILL BE UNINTERRUPTED, FREE OF MALICIOUS CODE OR
- ERROR-FREE, OR THAT DEFECTS WILL BE CORRECTED. THE WORLD BANK
- DISCLAIMS ALL LIABILITY AND RESPONSIBILITY ARISING FROM , OUT OF
- OR IN CONNECTION WITH THE SOFTWARE OR THE USE OF, PERFORMANCE OF
- OR OTHER DEALINGS IN THE SOFTWARE. THE WORLD BANK GROUP
- DISCLAIMS ALL EQUITABLE INDEMNITIES.
-
- 4. **Limitation of Liability.** THE WORLD BANK EXPRESSLY DISCLAIMS
- AND IN NO EVENT BE LIABLE UNDER ANY THEORY OF LIABILITY WHETHER
- BASED IN CONTRACT, TORT, STRICT LIABILITY OR OTHERWISE, FOR ANY
- DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, PERSONAL
- INJURY/WRONGFUL DEATH, PUNITIVE, OR EXEMPLARY DAMAGES (EVEN IF
- SUCH PARTIES KNEW OF OR SHOULD HAVE KNOWN OF THE POSSIBILITY OF
- SUCH DAMAGES), INCLUDING BUT NOT LIMITED TO AS A RESULT OF: (A)
- LICENSEE'S USE OF OR INABILITY TO USE THE SOFTWARE OR (B) ANY
- LOSS OF DATA. SHOULD ANY OF THEWORLD BANK BE FOUND TO BE LIABLE
- TO YOU OR ANY THIRD PARTY NOTWITHSTANDING THE FOREGOING, SUCH
- LIABILITY WILL NOT EXCEED \$100.00 IN THE AGGREGATE.
-
- 5. **Indemnity by Licensee.** Licensee agrees that Licensee will
- release, indemnify and hold harmless the World Bank and each of
- their respective business partners, content providers, licensors
- and service providers, and any of their respective officers,
- directors, shareholders, employees, contractors,
- representatives, or agents (including without limitation any
- authors or copyright holders of the Software) (collectively, the
- "World Bank Indemnified Parties") from and against any and all
- claims, actions, losses, damages, costs, fees and expenses
- (including attorneys' fees) arising out of or relating to: (i)
- Licensee's use or Exploitation of the Licensed Software, (ii)
- Licensee's data, (iii) Licensee's connection to the
- Software, (iv) Licensee's violation of this Agreement, (v)
- Licensee's violation of any rights of another, and/or (vi) the
- Exploitation and licensing of the Licensed Software by any
- person claiming rights by operation of any license granted by
- Licensee to such person.
-
- 6. **Waiver and Release.** Licensee hereby waives any rights and
- benefits it may have or that may accrue to it under any law
- providing that a general release does not extend to claims that
- the creditor does not know or suspect to exist in his, her or
- their favor at the time of executing the release, which if known
- by him, her or them must have materially affected his settlement
- with the debtor, or something substantially similar. The World
- Bank reserves the right, at its own expense, to assume the
- exclusive defense and control of any matter otherwise subject to
- indemnification by Licensee, and Licensee shall not in any event
- settle any matter without the written consent of the World Bank
- Indemnified Parties.
-
-5. Miscellaneous Provisions
-
- 1. **Governing Law.** This Agreement and the relationship between
- and among the Parties shall be governed by the Laws of the State
- of New York, United States of America, without giving effect to
- any choice or conflict of law provision or rule (whether of the
- state of New York or any other jurisdiction). Licensee agrees
- that regardless of any statute or law to the contrary, any claim
- or cause of action arising out of or related to use of the
- Software or this Agreement must be filed within one (1) year
- after such claim or cause of action arose or be forever barred.
-
- 2. **Remedies.** \[injunctive remedies, etc., to conform to
- arbitration clause.\]
-
- 3. **Arbitration.** Any controversy or claim arising out of or
- relating to this Agreement, or that contests the validity of
- this Agreement, shall be settled by arbitration in accordance
- with the UNCITRAL Arbitration Rules from time to time in force.
- The place of arbitration shall be New York, New York and the
- arbitration shall be conducted in English. The Parties hereby
- waive any rights under any applicable law to appeal any
- arbitration award or to seek determination of a preliminary
- point of law with respect to such proceedings. Notwithstanding
- the foregoing, The World Bank shall have the right to seek
- interim, provisional or other equitable relief, including
- temporary or permanent injunctive relief, as necessary to
- protect its interests.
-
- 4. **Preservation of Immunities.** Nothing in this Agreement and no
- submission by The World Bank to arbitration shall be construed
- as a limitation upon or a waiver, renunciation or modification
- of any immunities, privileges or exemptions of the World Bank
- accorded under any of the Articles of Agreement of the
- International Bank for Reconstruction and Development,
- international convention or any applicable law. Such immunities,
- privileges or exemptions are specifically reserved.
-
- 5. **Notices.** Any notice required or permitted to be given
- pursuant to this Agreement shall be effective if given by
- electronic mail addressed to the applicable Party at the address
- set forth in connection with its signature on this Agreement.
-
- 6. **Execution.** This Agreement may be executed in duplicates or
- counterparts and transmitted by facsimile or other imaging
- means.
-
-IN WITNESS WHEREOF, the Parties have executed this Agreement as of the
-\_\_\_ day of \_\_\_\_\_.
-
- --------------------------------------------------------------------------------------------------------------------------------------------------------------------
- International Bank for Reconstruction and Development / International Development Association \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
- ----------------------------------------------------------------------------------------------- --------------------------------------------------------------------
- By\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\ By \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
- its
-
- --------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
-**EXHIBIT A**
-
-**REQUIRED SUBLICENSE TERMS**
-
-A sublicense granted pursuant to the World Bank Master Community License
-Agreement shall include the following provisions:
-
-1. A preamble as follows:
-
-By acquiring a copy of the Survey Solutions (the "Subject
-Software"), the person so acquiring such copy, for himself/herself and
-on behalf of his or her employer or principal (collectively,
-"Licensee"), acknowledges and agrees that the exploitation of the
-Subject Software is subject strictly to the terms and conditions of this
-License Agreement, that Licensee is furthermore bound to perform all
-obligations of Licensee in all material respects, and that this
-Agreement may be enforced against Licensee by Licensor and/or any other
-person or entity who holds the copyright to the Core Software, the
-Licensed Software, or any Contribution thereto, as defined below.
-
-2. All definitions included in Article 1 of the Agreement.
-
-3. The following sections:
-
-**Basic Grant.** Subject to Licensee's compliance with all terms and
-conditions of this Agreement, Licensor grants to Licensee the
-royalty-free, perpetual, non-exclusive right and license to Exploit the
-Licensed Software, whether alone or as part of a Covered Work.
-
-**Territorial Limitations.** The rights granted to Licensee hereunder
-only apply to exploitation in the member countries of the World Bank
-("Licensed Territory").
-
-**Rights in Contributions.** Licensee hereby grants to Licensor and its
-licensors a paid up, royalty-free, perpetual, irrevocable,
-non-exclusive, sublicenseable right and license to Exploit any
-Contributions created by or for Licensee, effective immediately on the
-first Distribution of any work containing a Contribution.
-
-**Patent Rights.** Licensee further grants to Licensor and its licensors
-and their respective licensees a paid up, royalty-free, perpetual,
-irrevocable and sublicenseable license to Exploit its Contributions or
-any version of the Licensed Software including its Contributions under
-any patents now or in the future owned or licenseable by Licensee,
-solely to the extent that such Exploitation is of a work consisting of
-Licensed Software and Licensee's Contribution.
-
-**No Personal Use.** Licensee represents and warrants that the Licensed
-Software is not intended to be used and will not be used or authorized
-for use for personal, household and/or family uses.
-
-**Distribution of Source Code.** In the event that Licensee Distributes
-any form of the Licensed Software, whether as Source Code or Object Code
-and whether by itself or as part of a Covered Work, Licensee shall
-promptly make available the full Source Code of such Licensed Software
-(including any Contributions by Licensee) to all persons on the terms
-set forth in this License Agreement, either by making such Source Code
-accessible in a commonly available online source code repository, an
-online repository under the direct control of Licensee, or by notifying
-such persons that such Source Code may be delivered by electronic
-transmission to any requesting person, at no charge other than a
-reasonable fee covering the cost of distribution to the recipient.
-
-**Inclusion of Applicable License Provisions.** Licensee shall assure
-that every copy of Licensed Software (including any such copy included
-in a Covered Work) shall either include the full text of this license or
-a statement that identifies a uniform resource locator which contains
-the applicable license.
-
-**No Further Restrictions.** Licensee shall not impose any restrictions
-on the further use, distribution or modification of Licensed Software,
-whether distributed by itself or as part of a Covered Work, other than
-the terms of this License. Nothing herein shall prohibit Licensee from
-imposing any conditions Licensee sees fit on the subsequent distribution
-of Independent Software included in any Covered Work.
-
-**Non-infringement of Copyright.** Licensee hereby represents and
-warrants to Licensor Parties and any persons or entities who are
-licensees of Licensed Software that its Contributions are and/or will be
-either its original works of authorship or that it has sufficient rights
-in such Contributions to grant the rights required to be granted in such
-Contributions (and derivatives thereof) pursuant to this Agreement.
-
-**Patent Warranties.** Licensee hereby represents that, to the best of
-its knowledge, the combination of any Licensed Software with a
-Contribution from Licensee does not infringe the patent rights of any
-third party.
-
-**Disclaimer.** LICENSEE UNDERSTANDS AND AGREE THAT ITS USE (INCLUDING
-WITHOUT LIMITATION, THE EXERCISE OF ANY RIGHTS GRANTED TO IT UNDER THIS
-AGREEMENT) OF THE SOFTWARE IS AT LICENSEE'S SOLE RISK. THE SOFTWARE IS
-PROVIDED ON AN "AS IS" AND "AS AVAILABLE" BASIS. LICENSEE, FOR ITSELF
-AND ITS LICENSORS ("COLLECTIVELY LICENSOR PARTIES") DISCLAIM ALL
-REPRESENTATIONS AND WARRANTIES OF ANY KIND, WHETHER EXPRESS, IMPLIED, OR
-STATUTORY, WITH RESPECT TO THE SOFTWARE (INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED OR STATUTORY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
-PARTICULAR USE OR PURPOSE, TITLE, QUIET ENJOYMENT, AND NON-INFRINGEMENT.
-IN PARTICULAR, LICENSOR PARTIES DO NOT REPRESENT OR WARRANT THAT ANY
-INFORMATION OR OTHER CONTENT OBTAINED OR VIEWED BY LICENSEE OR ANYONE
-ELSE AS A RESULT OF LICENSEE'S EXPLOITATION OF THE SOFTWARE WILL BE
-ACCURATE, COMPLETE OR RELIABLE, THAT LICENSEE'S ACCESS TO THE SOFTWARE
-WILL BE UNINTERRUPTED, FREE OF MALICIOUS CODE OR ERROR-FREE, OR THAT
-DEFECTS WILL BE CORRECTED. LICENSOR PARTIES DISCLAIM ALL LIABILITY AND
-RESPONSIBILITY ARISING FROM , OUT OF OR IN CONNECTION WITH THE SOFTWARE
-OR THE USE OF, PERFORMANCE OF OR OTHER DEALINGS IN THE SOFTWARE.
-LICENSING PARTIES DISCLAIM ALL EQUITABLE INDEMNITIES.
-
-**Limitation of Liability.** LICENSOR PARTIES EXPRESSLY DISCLAIM AND IN
-NO EVENT WILL ANY OF THEM BE LIABLE UNDER ANY THEORY OF LIABILITY
-WHETHER BASED IN CONTRACT, TORT, STRICT LIABILITY OR OTHERWISE, FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, PERSONAL
-INJURY/WRONGFUL DEATH, PUNITIVE, OR EXEMPLARY DAMAGES (EVEN IF SUCH
-PARTIES KNEW OF OR SHOULD HAVE KNOWN OF THE POSSIBILITY OF SUCH
-DAMAGES), INCLUDING BUT NOT LIMITED TO AS A RESULT OF: (A) LICENSEE'S
-USE OF OR INABILITY TO USE THE SOFTWARE OR (B) ANY LOSS OF DATA. SHOULD
-THEWORLD BANK BE FOUND TO BE LIABLE TO YOU OR ANY THIRD PARTY
-NOTWITHSTANDING THE FOREGOING, SUCH LIABILITY WILL NOT EXCEED \$100.00
-IN THE AGGREGATE.
-
-**Indemnity by Licensee.** Licensee agrees that Licensee will release,
-indemnify and hold harmless Licensor Parties and each of Licensor
-Parties' respective business partners, content providers, licensors and
-service providers, and any of their respective officers, directors,
-shareholders, employees, contractors, representatives, or agents
-(including without limitation any authors or copyright holders of the
-Software) (collectively, the "Licensor Indemnified Parties") from and
-against any and all claims, actions, losses, damages, costs, fees and
-expenses (including attorneys' fees) arising out of or relating to: (i)
-Licensee's use or Exploitation of the Licensed Software, (ii) Licensee's
-data, (iii) Licensee's connection to the Software, (iv) Licensee's
-violation of this Agreement, (v) Licensee's violation of any rights of
-another, and/or (vi) the Exploitation and licensing of the Licensed
-Software by any person claiming rights by operation of any license
-granted by Licensee to such person.
-
-**Express Third Party Beneficiary.** Licensee acknowledges and agrees
-that the World Bank is an express third party beneficiary of this
-agreement and is entitled to enforce the terms of this Agreement or to
-assume the prosecution of any remedy, either in addition to or in lieu
-of enforcement undertaken by Licensor.
-
-**Governing Law.** This Agreement and the relationship between and among
-the Parties shall be governed by the Laws of the State of New York,
-United States of America, without giving effect to any choice or
-conflict of law provision or rule (whether of the state of New York or
-any other jurisdiction). Licensee agrees that regardless of any statute
-or law to the contrary, any claim or cause of action arising out of or
-related to use of the Software or this Agreement must be filed within
-one (1) year after such claim or cause of action arose or be forever
-barred.
-
-**Arbitration.** This Agreement, at the option of Licensor, or The World
-Bank so elects, The World Bank, may be enforced against Licensee in the
-state or federal courts of the State of New York, the courts of the
-country in which Licensee resides, or any other appropriate
-jurisdiction, or concurrently in more than one jurisdiction. Subject to
-the foregoing option of Licensor or The World Bank, any controversy or
-claim arising out of or relating to this Agreement, or that contests the
-validity of this Agreement, shall be settled by arbitration in
-accordance with the UNCITRAL Arbitration Rules from time to time in
-force. The place of arbitration shall be New York, New York and the
-arbitration shall be conducted in English. The Parties hereby waive any
-rights under any applicable law to appeal any arbitration award or to
-seek determination of a preliminary point of law with respect to such
-proceedings. Notwithstanding the foregoing, The World Bank shall have
-the right to seek interim, provisional or other equitable relief,
-including temporary or permanent injunctive relief, as necessary to
-protect its interests.
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+ means each individual or legal entity that creates, contributes to
+ the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+ means the combination of the Contributions of others (if any) used
+ by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+ means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+ means Source Code Form to which the initial Contributor has attached
+ the notice in Exhibit A, the Executable Form of such Source Code
+ Form, and Modifications of such Source Code Form, in each case
+ including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+ means
+
+ (a) that the initial Contributor has attached the notice described
+ in Exhibit B to the Covered Software; or
+
+ (b) that the Covered Software was made available under the terms of
+ version 1.1 or earlier of the License, but not also under the
+ terms of a Secondary License.
+
+1.6. "Executable Form"
+ means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+ means a work that combines Covered Software with other material, in
+ a separate file or files, that is not Covered Software.
+
+1.8. "License"
+ means this document.
+
+1.9. "Licensable"
+ means having the right to grant, to the maximum extent possible,
+ whether at the time of the initial grant or subsequently, any and
+ all of the rights conveyed by this License.
+
+1.10. "Modifications"
+ means any of the following:
+
+ (a) any file in Source Code Form that results from an addition to,
+ deletion from, or modification of the contents of Covered
+ Software; or
+
+ (b) any new file in Source Code Form that contains any Covered
+ Software.
+
+1.11. "Patent Claims" of a Contributor
+ means any patent claim(s), including without limitation, method,
+ process, and apparatus claims, in any patent Licensable by such
+ Contributor that would be infringed, but for the grant of the
+ License, by the making, using, selling, offering for sale, having
+ made, import, or transfer of either its Contributions or its
+ Contributor Version.
+
+1.12. "Secondary License"
+ means either the GNU General Public License, Version 2.0, the GNU
+ Lesser General Public License, Version 2.1, the GNU Affero General
+ Public License, Version 3.0, or any later versions of those
+ licenses.
+
+1.13. "Source Code Form"
+ means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+ means an individual or a legal entity exercising rights under this
+ License. For legal entities, "You" includes any entity that
+ controls, is controlled by, or is under common control with You. For
+ purposes of this definition, "control" means (a) the power, direct
+ or indirect, to cause the direction or management of such entity,
+ whether by contract or otherwise, or (b) ownership of more than
+ fifty percent (50%) of the outstanding shares or beneficial
+ ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+ Licensable by such Contributor to use, reproduce, make available,
+ modify, display, perform, distribute, and otherwise exploit its
+ Contributions, either on an unmodified basis, with Modifications, or
+ as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+ for sale, have made, import, and otherwise transfer either its
+ Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+ or
+
+(b) for infringements caused by: (i) Your and any other third party's
+ modifications of Covered Software, or (ii) the combination of its
+ Contributions with other software (except as part of its Contributor
+ Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+ its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+ Form, as described in Section 3.1, and You must inform recipients of
+ the Executable Form how they can obtain a copy of such Source Code
+ Form by reasonable means in a timely manner, at a charge no more
+ than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+ License, or sublicense it under different terms, provided that the
+ license for the Executable Form does not attempt to limit or alter
+ the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+* *
+* 6. Disclaimer of Warranty *
+* ------------------------- *
+* *
+* Covered Software is provided under this License on an "as is" *
+* basis, without warranty of any kind, either expressed, implied, or *
+* statutory, including, without limitation, warranties that the *
+* Covered Software is free of defects, merchantable, fit for a *
+* particular purpose or non-infringing. The entire risk as to the *
+* quality and performance of the Covered Software is with You. *
+* Should any Covered Software prove defective in any respect, You *
+* (not any Contributor) assume the cost of any necessary servicing, *
+* repair, or correction. This disclaimer of warranty constitutes an *
+* essential part of this License. No use of any Covered Software is *
+* authorized under this License except under this disclaimer. *
+* *
+************************************************************************
+
+************************************************************************
+* *
+* 7. Limitation of Liability *
+* -------------------------- *
+* *
+* Under no circumstances and under no legal theory, whether tort *
+* (including negligence), contract, or otherwise, shall any *
+* Contributor, or anyone who distributes Covered Software as *
+* permitted above, be liable to You for any direct, indirect, *
+* special, incidental, or consequential damages of any character *
+* including, without limitation, damages for lost profits, loss of *
+* goodwill, work stoppage, computer failure or malfunction, or any *
+* and all other commercial damages or losses, even if such party *
+* shall have been informed of the possibility of such damages. This *
+* limitation of liability shall not apply to liability for death or *
+* personal injury resulting from such party's negligence to the *
+* extent applicable law prohibits such limitation. Some *
+* jurisdictions do not allow the exclusion or limitation of *
+* incidental or consequential damages, so this exclusion and *
+* limitation may not apply to You. *
+* *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+ This Source Code Form is subject to the terms of the Mozilla Public
+ License, v. 2.0. If a copy of the MPL was not distributed with this
+ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+ This Source Code Form is "Incompatible With Secondary Licenses", as
+ defined by the Mozilla Public License, v. 2.0.
diff --git a/Makefile b/Makefile
deleted file mode 100644
index 4939ec0..0000000
--- a/Makefile
+++ /dev/null
@@ -1,8 +0,0 @@
-
-all: build serve
-
-build:
- jupyter-book build . --config docs/_config.yml --toc docs/_toc.yml
-
-serve:
- open _build/html/index.html
diff --git a/README.md b/README.md
index a9d54d0..4d10749 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,7 @@
# Development Data Partnership Heatwaves
-> A partnership between international organizations and companies, created to facilitate the use of third-party data in research and international development.
-
-Since the Partnership's domain (datapartnership.org) is registered to [GitHub Pages](https://pages.github.com), we can create project pages under the same domain.
+g
## License
-The `heatwaves` repository is licensed under the **World Bank Master Community License Agreement**.
+This projects is licensed under the [**Mozilla Public License**](https://opensource.org/license/mpl-2-0/) - see the [LICENSE](LICENSE) file for details.
diff --git a/docs/requirements.txt b/docs/requirements.txt
deleted file mode 100644
index a2a1020..0000000
--- a/docs/requirements.txt
+++ /dev/null
@@ -1 +0,0 @@
-jupyter-book==0.14
\ No newline at end of file
diff --git a/environment.yml b/notebooks/environment.yml
similarity index 92%
rename from environment.yml
rename to notebooks/environment.yml
index 615d7cf..33333a6 100644
--- a/environment.yml
+++ b/notebooks/environment.yml
@@ -8,4 +8,4 @@ dependencies:
- netCDF4
- shapely
- rioxarray
- - xarray
\ No newline at end of file
+ - xarray
diff --git a/notebooks/measuring-heatwaves/heatwaves-in-philippines.ipynb b/notebooks/measuring-heatwaves/heatwaves-in-philippines.ipynb
index b836394..3d44bee 100644
--- a/notebooks/measuring-heatwaves/heatwaves-in-philippines.ipynb
+++ b/notebooks/measuring-heatwaves/heatwaves-in-philippines.ipynb
@@ -42,15 +42,11 @@
"%autoreload 2\n",
"\n",
"import pandas as pd\n",
- "import rioxarray\n",
"import xarray as xr\n",
- "from netCDF4 import Dataset\n",
"import geopandas\n",
"\n",
- "import dask.dataframe as dd\n",
- "import dask_geopandas as dg\n",
"\n",
- "from heatwaves.weather import *\n"
+ "from heatwaves.weather import *"
]
},
{
@@ -66,13 +62,12 @@
"import bokeh\n",
"from bokeh.layouts import *\n",
"from bokeh.models import *\n",
- "import matplotlib as mpl\n",
"\n",
"from bokeh.core.validation.warnings import EMPTY_LAYOUT, MISSING_RENDERERS\n",
+ "\n",
"bokeh.core.validation.silence(EMPTY_LAYOUT, True)\n",
"bokeh.core.validation.silence(MISSING_RENDERERS, True)\n",
- "from bokeh.plotting import figure, output_file, show, output_notebook\n",
- "from bokeh.models import Span"
+ "from bokeh.plotting import show, output_notebook"
]
},
{
@@ -120,13 +115,28 @@
},
"outputs": [],
"source": [
- "PHILIPPINES = geopandas.read_file('../../data/shapefiles/philippines/phl_adminboundaries_candidate_exclude_adm3/phl_admbnda_adm2_psa_namria_20200529.shp')\n",
- "MANILA = PHILIPPINES[PHILIPPINES['ADM2_EN'].isin(['NCR, City of Manila, First District', 'NCR, Second District', 'NCR, Third District', 'NCR, Fourth District'])]\n",
- "PHILIPPINES_ADM3 = geopandas.read_file('../../data/shapefiles/philippines/phl_adminboundaries_candidate_adm3/phl_admbnda_adm3_psa_namria_20200529.shp')\n",
- "DAVAO = PHILIPPINES_ADM3[PHILIPPINES_ADM3['ADM3_EN'].isin(['Davao City'])]\n",
- "ZAMBOANGA = PHILIPPINES_ADM3[PHILIPPINES_ADM3['ADM3_EN'].isin(['Zamboanga City'])]\n",
- "CEBU = PHILIPPINES_ADM3[PHILIPPINES_ADM3['ADM3_EN'].isin(['Cebu City'])]\n",
- "PHILIPPINES_ADM1= geopandas.read_file('../../data/shapefiles/philippines/phl_adminboundaries_candidate_exclude_adm3/phl_admbnda_adm1_psa_namria_20200529.shp')"
+ "PHILIPPINES = geopandas.read_file(\n",
+ " \"../../data/shapefiles/philippines/phl_adminboundaries_candidate_exclude_adm3/phl_admbnda_adm2_psa_namria_20200529.shp\"\n",
+ ")\n",
+ "MANILA = PHILIPPINES[\n",
+ " PHILIPPINES[\"ADM2_EN\"].isin(\n",
+ " [\n",
+ " \"NCR, City of Manila, First District\",\n",
+ " \"NCR, Second District\",\n",
+ " \"NCR, Third District\",\n",
+ " \"NCR, Fourth District\",\n",
+ " ]\n",
+ " )\n",
+ "]\n",
+ "PHILIPPINES_ADM3 = geopandas.read_file(\n",
+ " \"../../data/shapefiles/philippines/phl_adminboundaries_candidate_adm3/phl_admbnda_adm3_psa_namria_20200529.shp\"\n",
+ ")\n",
+ "DAVAO = PHILIPPINES_ADM3[PHILIPPINES_ADM3[\"ADM3_EN\"].isin([\"Davao City\"])]\n",
+ "ZAMBOANGA = PHILIPPINES_ADM3[PHILIPPINES_ADM3[\"ADM3_EN\"].isin([\"Zamboanga City\"])]\n",
+ "CEBU = PHILIPPINES_ADM3[PHILIPPINES_ADM3[\"ADM3_EN\"].isin([\"Cebu City\"])]\n",
+ "PHILIPPINES_ADM1 = geopandas.read_file(\n",
+ " \"../../data/shapefiles/philippines/phl_adminboundaries_candidate_exclude_adm3/phl_admbnda_adm1_psa_namria_20200529.shp\"\n",
+ ")"
]
},
{
@@ -159,8 +169,8 @@
},
"outputs": [],
"source": [
- "#PHL_POP_ADM1 = geopandas.read_file('../../data/population/philippines_population_adm1.geojson')\n",
- "#PHL_POP_ADM2 = geopandas.read_file('../../data/population/philippines_population_adm2.geojson')"
+ "# PHL_POP_ADM1 = geopandas.read_file('../../data/population/philippines_population_adm1.geojson')\n",
+ "# PHL_POP_ADM2 = geopandas.read_file('../../data/population/philippines_population_adm2.geojson')"
]
},
{
@@ -180,9 +190,9 @@
},
"outputs": [],
"source": [
- "#population_adm1 = PHILIPPINES_ADM1.sjoin(population_gdf)\n",
- "#population_adm2 = PHILIPPINES.sjoin(population_gdf)\n",
- "#population_adm3 = PHILIPPINES_ADM3.sjoin(population_gdf)\n"
+ "# population_adm1 = PHILIPPINES_ADM1.sjoin(population_gdf)\n",
+ "# population_adm2 = PHILIPPINES.sjoin(population_gdf)\n",
+ "# population_adm3 = PHILIPPINES_ADM3.sjoin(population_gdf)\n"
]
},
{
@@ -195,7 +205,12 @@
},
"outputs": [],
"source": [
- "population_adm1 = population_adm1[['ADM1_EN', 'phl_general_2020']].groupby(['ADM1_EN']).sum().reset_index()\n",
+ "population_adm1 = (\n",
+ " population_adm1[[\"ADM1_EN\", \"phl_general_2020\"]]\n",
+ " .groupby([\"ADM1_EN\"])\n",
+ " .sum()\n",
+ " .reset_index()\n",
+ ")\n",
"# population_adm2 = population_adm2[['ADM2_EN', 'phl_general_2020']].groupby(['ADM2_EN', 'ADM1_EN']).sum().reset_index()\n",
"# population_adm3 = population_adm3[['ADM3_EN', 'phl_general_2020']].groupby(['ADM3_EN', 'ADM2_EN', 'ADM1_EN']).sum().reset_index()"
]
@@ -240,18 +255,18 @@
"source": [
"import matplotlib.pyplot as plt\n",
"\n",
- "fig, ax = plt.subplots(1,3, figsize=(36,6))\n",
+ "fig, ax = plt.subplots(1, 3, figsize=(36, 6))\n",
"plt.rcParams[\"font.family\"] = \"cursive\"\n",
"\n",
- "PHILIPPINES_ADM1.plot(column='phl_general_2020', legend = False, ax=ax[0])\n",
- "PHILIPPINES_ADM2.plot(column='phl_general_2020', legend = False, ax=ax[1])\n",
- "PHILIPPINES_ADM3.plot(column='phl_general_2020', legend = True, ax=ax[2])\n",
+ "PHILIPPINES_ADM1.plot(column=\"phl_general_2020\", legend=False, ax=ax[0])\n",
+ "PHILIPPINES_ADM2.plot(column=\"phl_general_2020\", legend=False, ax=ax[1])\n",
+ "PHILIPPINES_ADM3.plot(column=\"phl_general_2020\", legend=True, ax=ax[2])\n",
"\n",
- "for i in range(0,2):\n",
- " ax[i].spines['top'].set_visible(False)\n",
- " ax[i].spines['bottom'].set_visible(False)\n",
- " ax[i].spines['right'].set_visible(False)\n",
- " ax[i].spines['left'].set_visible(False)\n",
+ "for i in range(0, 2):\n",
+ " ax[i].spines[\"top\"].set_visible(False)\n",
+ " ax[i].spines[\"bottom\"].set_visible(False)\n",
+ " ax[i].spines[\"right\"].set_visible(False)\n",
+ " ax[i].spines[\"left\"].set_visible(False)\n",
"\n",
" ax[i].set_xticks([])\n",
" ax[i].set_yticks([])"
@@ -293,7 +308,9 @@
},
"outputs": [],
"source": [
- "ds_mean2_gldas=xr.open_mfdataset(\"../../data/gldas/ymean2/wld_cli_*.nc4\", parallel = True)"
+ "ds_mean2_gldas = xr.open_mfdataset(\n",
+ " \"../../data/gldas/ymean2/wld_cli_*.nc4\", parallel=True\n",
+ ")"
]
},
{
@@ -307,7 +324,7 @@
"outputs": [],
"source": [
"def add_city_name(df, city_name):\n",
- " df['city'] = city_name\n",
+ " df[\"city\"] = city_name\n",
"\n",
" return df"
]
@@ -322,12 +339,22 @@
},
"outputs": [],
"source": [
- "manila_hwdi_mean2 = add_city_name(clip_area(ds_mean2_gldas, MANILA).to_dataframe().reset_index(), 'Manila')\n",
- "davao_hwdi_mean2 = add_city_name(clip_area(ds_mean2_gldas, DAVAO).to_dataframe().reset_index(), 'Davao')\n",
- "zamboanga_hwdi_mean2 = add_city_name(clip_area(ds_mean2_gldas, ZAMBOANGA).to_dataframe().reset_index(), 'Zamboanga')\n",
- "cebu_hwdi_mean2 = add_city_name(clip_area(ds_mean2_gldas, CEBU).to_dataframe().reset_index(), 'Cebu')\n",
+ "manila_hwdi_mean2 = add_city_name(\n",
+ " clip_area(ds_mean2_gldas, MANILA).to_dataframe().reset_index(), \"Manila\"\n",
+ ")\n",
+ "davao_hwdi_mean2 = add_city_name(\n",
+ " clip_area(ds_mean2_gldas, DAVAO).to_dataframe().reset_index(), \"Davao\"\n",
+ ")\n",
+ "zamboanga_hwdi_mean2 = add_city_name(\n",
+ " clip_area(ds_mean2_gldas, ZAMBOANGA).to_dataframe().reset_index(), \"Zamboanga\"\n",
+ ")\n",
+ "cebu_hwdi_mean2 = add_city_name(\n",
+ " clip_area(ds_mean2_gldas, CEBU).to_dataframe().reset_index(), \"Cebu\"\n",
+ ")\n",
"\n",
- "phl_cities_hwdi_mean2 = pd.concat([manila_hwdi_mean2, zamboanga_hwdi_mean2, davao_hwdi_mean2, cebu_hwdi_mean2])"
+ "phl_cities_hwdi_mean2 = pd.concat(\n",
+ " [manila_hwdi_mean2, zamboanga_hwdi_mean2, davao_hwdi_mean2, cebu_hwdi_mean2]\n",
+ ")"
]
},
{
@@ -380,7 +407,15 @@
],
"source": [
"output_notebook()\n",
- "show(get_line_plot(phl_cities_hwdi_mean2, measure = 'heat_waves_per_time_period', title = 'Heatwaves per time period', subtitle = 'heatwave is defined as 2 consecutive days where the mean temperature is more than 5 degrees of the mean temperature of the baseline from 1948 to 2014', source= 'GLDAS data with analysis from the Data Lab, World Bank'))"
+ "show(\n",
+ " get_line_plot(\n",
+ " phl_cities_hwdi_mean2,\n",
+ " measure=\"heat_waves_per_time_period\",\n",
+ " title=\"Heatwaves per time period\",\n",
+ " subtitle=\"heatwave is defined as 2 consecutive days where the mean temperature is more than 5 degrees of the mean temperature of the baseline from 1948 to 2014\",\n",
+ " source=\"GLDAS data with analysis from the Data Lab, World Bank\",\n",
+ " )\n",
+ ")"
]
},
{
@@ -393,10 +428,19 @@
},
"outputs": [],
"source": [
- "manila_heatindex = add_city_name(pd.read_csv('../../data/gldas/heatindex/manila_heat_index_daily.csv'), 'Manila')\n",
- "davao_heatindex = add_city_name(pd.read_csv('../../data/gldas/heatindex/davao_heat_index_daily.csv'), 'Davao')\n",
- "zamboanga_heatindex = add_city_name(pd.read_csv('../../data/gldas/heatindex/zamboanga_heat_index_daily.csv'), 'Zamboanga')\n",
- "cebu_heatindex = add_city_name(pd.read_csv('../../data/gldas/heatindex/cebu_heat_index_daily.csv'), 'Cebu')"
+ "manila_heatindex = add_city_name(\n",
+ " pd.read_csv(\"../../data/gldas/heatindex/manila_heat_index_daily.csv\"), \"Manila\"\n",
+ ")\n",
+ "davao_heatindex = add_city_name(\n",
+ " pd.read_csv(\"../../data/gldas/heatindex/davao_heat_index_daily.csv\"), \"Davao\"\n",
+ ")\n",
+ "zamboanga_heatindex = add_city_name(\n",
+ " pd.read_csv(\"../../data/gldas/heatindex/zamboanga_heat_index_daily.csv\"),\n",
+ " \"Zamboanga\",\n",
+ ")\n",
+ "cebu_heatindex = add_city_name(\n",
+ " pd.read_csv(\"../../data/gldas/heatindex/cebu_heat_index_daily.csv\"), \"Cebu\"\n",
+ ")"
]
},
{
@@ -409,7 +453,9 @@
},
"outputs": [],
"source": [
- "phl_cities_heatindex = pd.concat([manila_heatindex, zamboanga_heatindex, davao_heatindex, cebu_heatindex])"
+ "phl_cities_heatindex = pd.concat(\n",
+ " [manila_heatindex, zamboanga_heatindex, davao_heatindex, cebu_heatindex]\n",
+ ")"
]
},
{
@@ -418,8 +464,13 @@
"metadata": {},
"outputs": [],
"source": [
- "phl_cities_heatindex_year = phl_cities_heatindex[['city', 'time', 'heat_index']].groupby([pd.Grouper(key='time', freq='Y'), 'city']).agg({'mean', 'max', 'min'}).reset_index()\n",
- "phl_cities_heatindex_year.set_index(['time', 'city'], inplace=True)\n",
+ "phl_cities_heatindex_year = (\n",
+ " phl_cities_heatindex[[\"city\", \"time\", \"heat_index\"]]\n",
+ " .groupby([pd.Grouper(key=\"time\", freq=\"Y\"), \"city\"])\n",
+ " .agg({\"mean\", \"max\", \"min\"})\n",
+ " .reset_index()\n",
+ ")\n",
+ "phl_cities_heatindex_year.set_index([\"time\", \"city\"], inplace=True)\n",
"phl_cities_heatindex_year.columns = phl_cities_heatindex_year.columns.droplevel(0)\n",
"phl_cities_heatindex_year.reset_index(inplace=True)"
]
@@ -430,7 +481,9 @@
"metadata": {},
"outputs": [],
"source": [
- "phl_cities_heatindex['time'] = phl_cities_heatindex['time'].apply(lambda x: datetime.strptime(x, '%Y-%m-%d %H:%M:%S'))"
+ "phl_cities_heatindex[\"time\"] = phl_cities_heatindex[\"time\"].apply(\n",
+ " lambda x: datetime.strptime(x, \"%Y-%m-%d %H:%M:%S\")\n",
+ ")"
]
},
{
@@ -484,15 +537,25 @@
"source": [
"output_notebook()\n",
"from bokeh.models import Panel\n",
+ "\n",
"bokeh.core.validation.silence(EMPTY_LAYOUT, True)\n",
"bokeh.core.validation.silence(MISSING_RENDERERS, True)\n",
"\n",
"tabs = []\n",
"\n",
- "for value in list(['min', 'max', 'mean']):\n",
- "\n",
- " tabs.append(Panel(child=get_line_plot(phl_cities_heatindex_year.reset_index(), f\"Heat Index Per Year\", \"Source: GLDAS NASA - Heat index calculated using NWS (2011)\",measure=value, subtitle = 'Heat index is calculated using both temperature and relative humidity'), title=value.capitalize()\n",
- " ))\n",
+ "for value in list([\"min\", \"max\", \"mean\"]):\n",
+ " tabs.append(\n",
+ " Panel(\n",
+ " child=get_line_plot(\n",
+ " phl_cities_heatindex_year.reset_index(),\n",
+ " \"Heat Index Per Year\",\n",
+ " \"Source: GLDAS NASA - Heat index calculated using NWS (2011)\",\n",
+ " measure=value,\n",
+ " subtitle=\"Heat index is calculated using both temperature and relative humidity\",\n",
+ " ),\n",
+ " title=value.capitalize(),\n",
+ " )\n",
+ " )\n",
"\n",
"tabs = Tabs(tabs=tabs, sizing_mode=\"scale_both\")\n",
"show(tabs, warn_on_missing_glyphs=False)"
@@ -518,13 +581,25 @@
},
"outputs": [],
"source": [
- "manilaport_heatindex_pagasa = add_city_name(geopandas.read_file('../../data/pasay/pag_port.geojson'), 'Manila Port')\n",
- "manilaquezon_heatindex_pagasa = add_city_name(geopandas.read_file('../../data/pasay/pag_quezon.geojson'), 'Quezon')\n",
- "manilapasay_heatindex_pagasa = add_city_name(geopandas.read_file('../../data/pasay/pag_pasay.geojson'), 'Pasay')\n",
+ "manilaport_heatindex_pagasa = add_city_name(\n",
+ " geopandas.read_file(\"../../data/pasay/pag_port.geojson\"), \"Manila Port\"\n",
+ ")\n",
+ "manilaquezon_heatindex_pagasa = add_city_name(\n",
+ " geopandas.read_file(\"../../data/pasay/pag_quezon.geojson\"), \"Quezon\"\n",
+ ")\n",
+ "manilapasay_heatindex_pagasa = add_city_name(\n",
+ " geopandas.read_file(\"../../data/pasay/pag_pasay.geojson\"), \"Pasay\"\n",
+ ")\n",
"\n",
- "manilaport_heatindex_pagasa_max = add_city_name(geopandas.read_file('../../data/pasay/pag_port_max.geojson'), 'Manila Port')\n",
- "manilaquezon_heatindex_pagasa_max = add_city_name(geopandas.read_file('../../data/pasay/pag_quezon_max.geojson'), 'Quezon')\n",
- "manilapasay_heatindex_pagasa_max = add_city_name(geopandas.read_file('../../data/pasay/pag_pasay_max.geojson'), 'Pasay')"
+ "manilaport_heatindex_pagasa_max = add_city_name(\n",
+ " geopandas.read_file(\"../../data/pasay/pag_port_max.geojson\"), \"Manila Port\"\n",
+ ")\n",
+ "manilaquezon_heatindex_pagasa_max = add_city_name(\n",
+ " geopandas.read_file(\"../../data/pasay/pag_quezon_max.geojson\"), \"Quezon\"\n",
+ ")\n",
+ "manilapasay_heatindex_pagasa_max = add_city_name(\n",
+ " geopandas.read_file(\"../../data/pasay/pag_pasay_max.geojson\"), \"Pasay\"\n",
+ ")"
]
},
{
@@ -549,8 +624,13 @@
"outputs": [],
"source": [
"from datetime import datetime\n",
- "manilaport_heatindex_pagasa_max['Date'] = manilaport_heatindex_pagasa_max['Date'].apply(lambda x: datetime.strptime(x, '%d/%m/%Y'))\n",
- "manilaquezon_heatindex_pagasa_max['Date'] = pd.to_datetime(manilaquezon_heatindex_pagasa_max[['Year', 'Month', 'Day']])"
+ "\n",
+ "manilaport_heatindex_pagasa_max[\"Date\"] = manilaport_heatindex_pagasa_max[\"Date\"].apply(\n",
+ " lambda x: datetime.strptime(x, \"%d/%m/%Y\")\n",
+ ")\n",
+ "manilaquezon_heatindex_pagasa_max[\"Date\"] = pd.to_datetime(\n",
+ " manilaquezon_heatindex_pagasa_max[[\"Year\", \"Month\", \"Day\"]]\n",
+ ")"
]
},
{
@@ -574,8 +654,20 @@
},
"outputs": [],
"source": [
- "phl_cities_heatindex_pagasa = pd.concat([manilaport_heatindex_pagasa, manilaquezon_heatindex_pagasa, manilapasay_heatindex_pagasa])\n",
- "phl_cities_heatindex_pagasa_max = pd.concat([manilaport_heatindex_pagasa_max, manilaquezon_heatindex_pagasa_max, manilapasay_heatindex_pagasa_max])"
+ "phl_cities_heatindex_pagasa = pd.concat(\n",
+ " [\n",
+ " manilaport_heatindex_pagasa,\n",
+ " manilaquezon_heatindex_pagasa,\n",
+ " manilapasay_heatindex_pagasa,\n",
+ " ]\n",
+ ")\n",
+ "phl_cities_heatindex_pagasa_max = pd.concat(\n",
+ " [\n",
+ " manilaport_heatindex_pagasa_max,\n",
+ " manilaquezon_heatindex_pagasa_max,\n",
+ " manilapasay_heatindex_pagasa_max,\n",
+ " ]\n",
+ ")"
]
},
{
@@ -588,8 +680,8 @@
},
"outputs": [],
"source": [
- "phl_cities_heatindex_pagasa_max.rename(columns = {'Date':'time'}, inplace=True)\n",
- "phl_cities_heatindex_pagasa.rename(columns = {'Date':'time'}, inplace=True)"
+ "phl_cities_heatindex_pagasa_max.rename(columns={\"Date\": \"time\"}, inplace=True)\n",
+ "phl_cities_heatindex_pagasa.rename(columns={\"Date\": \"time\"}, inplace=True)"
]
},
{
@@ -602,8 +694,12 @@
},
"outputs": [],
"source": [
- "manila_heatindex_tomorrowio_mean = pd.read_csv('../../data/tomorrow.io/manila_april2023_mean_heat_index.csv')\n",
- "manila_heatindex_tomorrowio_max= pd.read_csv('../../data/tomorrow.io/manila_april2023_max_heat_index.csv')"
+ "manila_heatindex_tomorrowio_mean = pd.read_csv(\n",
+ " \"../../data/tomorrow.io/manila_april2023_mean_heat_index.csv\"\n",
+ ")\n",
+ "manila_heatindex_tomorrowio_max = pd.read_csv(\n",
+ " \"../../data/tomorrow.io/manila_april2023_max_heat_index.csv\"\n",
+ ")"
]
},
{
@@ -616,8 +712,12 @@
},
"outputs": [],
"source": [
- "manila_heatindex_tomorrowio_mean['startTime'] = manila_heatindex_tomorrowio_mean['startTime'].apply(lambda x: datetime.strptime(x, '%Y-%m-%dT%H:%M:%S'))\n",
- "manila_heatindex_tomorrowio_max['startTime'] = manila_heatindex_tomorrowio_max['startTime'].apply(lambda x: datetime.strptime(x, '%Y-%m-%dT%H:%M:%S'))"
+ "manila_heatindex_tomorrowio_mean[\"startTime\"] = manila_heatindex_tomorrowio_mean[\n",
+ " \"startTime\"\n",
+ "].apply(lambda x: datetime.strptime(x, \"%Y-%m-%dT%H:%M:%S\"))\n",
+ "manila_heatindex_tomorrowio_max[\"startTime\"] = manila_heatindex_tomorrowio_max[\n",
+ " \"startTime\"\n",
+ "].apply(lambda x: datetime.strptime(x, \"%Y-%m-%dT%H:%M:%S\"))"
]
},
{
@@ -630,8 +730,16 @@
},
"outputs": [],
"source": [
- "manila_heatindex_tomorrowio_mean = manila_heatindex_tomorrowio_mean.groupby(['startTime']).mean()[['heat_index_C']].reset_index()\n",
- "manila_heatindex_tomorrowio_max = manila_heatindex_tomorrowio_max.groupby(['startTime']).mean()[['heat_index_C']].reset_index()"
+ "manila_heatindex_tomorrowio_mean = (\n",
+ " manila_heatindex_tomorrowio_mean.groupby([\"startTime\"])\n",
+ " .mean()[[\"heat_index_C\"]]\n",
+ " .reset_index()\n",
+ ")\n",
+ "manila_heatindex_tomorrowio_max = (\n",
+ " manila_heatindex_tomorrowio_max.groupby([\"startTime\"])\n",
+ " .mean()[[\"heat_index_C\"]]\n",
+ " .reset_index()\n",
+ ")"
]
},
{
@@ -644,8 +752,8 @@
},
"outputs": [],
"source": [
- "manila_heatindex_tomorrowio_mean['city'] = 'Manila'\n",
- "manila_heatindex_tomorrowio_max['city'] = 'Manila'"
+ "manila_heatindex_tomorrowio_mean[\"city\"] = \"Manila\"\n",
+ "manila_heatindex_tomorrowio_max[\"city\"] = \"Manila\""
]
},
{
@@ -658,8 +766,12 @@
},
"outputs": [],
"source": [
- "manila_heatindex_tomorrowio_mean.rename(columns = {'startTime':'time', 'heat_index_C':'Average Heat Index'}, inplace=True)\n",
- "manila_heatindex_tomorrowio_max.rename(columns = {'startTime':'time', 'heat_index_C':'Maximum Heat Index'}, inplace=True)"
+ "manila_heatindex_tomorrowio_mean.rename(\n",
+ " columns={\"startTime\": \"time\", \"heat_index_C\": \"Average Heat Index\"}, inplace=True\n",
+ ")\n",
+ "manila_heatindex_tomorrowio_max.rename(\n",
+ " columns={\"startTime\": \"time\", \"heat_index_C\": \"Maximum Heat Index\"}, inplace=True\n",
+ ")"
]
},
{
@@ -724,7 +836,15 @@
],
"source": [
"output_notebook()\n",
- "show(get_line_plot(pd.concat([manila_heatindex_tomorrowio_max, phl_cities_heatindex_pagasa_max]), measure = 'Maximum Heat Index', title = 'Max Heat Index', subtitle = 'heat index calculated from Tomorrow.io', source= 'Tomorrow.io'))"
+ "show(\n",
+ " get_line_plot(\n",
+ " pd.concat([manila_heatindex_tomorrowio_max, phl_cities_heatindex_pagasa_max]),\n",
+ " measure=\"Maximum Heat Index\",\n",
+ " title=\"Max Heat Index\",\n",
+ " subtitle=\"heat index calculated from Tomorrow.io\",\n",
+ " source=\"Tomorrow.io\",\n",
+ " )\n",
+ ")"
]
},
{
@@ -789,7 +909,15 @@
],
"source": [
"output_notebook()\n",
- "show(get_line_plot(pd.concat([manila_heatindex_tomorrowio_mean, phl_cities_heatindex_pagasa]), measure = 'Average Heat Index', title = 'Mean Heat Index', subtitle = 'heat index calculated from Tomorrow.io', source= 'Tomorrow.io'))"
+ "show(\n",
+ " get_line_plot(\n",
+ " pd.concat([manila_heatindex_tomorrowio_mean, phl_cities_heatindex_pagasa]),\n",
+ " measure=\"Average Heat Index\",\n",
+ " title=\"Mean Heat Index\",\n",
+ " subtitle=\"heat index calculated from Tomorrow.io\",\n",
+ " source=\"Tomorrow.io\",\n",
+ " )\n",
+ ")"
]
},
{
diff --git a/pyproject.toml b/pyproject.toml
index aef0369..db355fb 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,22 +1,20 @@
[build-system]
-requires = ["setuptools>=61.0.0"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling>=1.21.0", "hatch-vcs>=0.3.0"]
+build-backend = "hatchling.build"
[project]
name = "heatwaves"
-dynamic = ["version"]
-description = "Package for mesuring impact of and vulnerability to heatwaves created by the WB Data Lab"
-readme = {file = "README.md", content-type = "text/markdown"}
-license = {file = "LICENSE"}
-keywords = ["world bank", "climate change", "heatwave"]
-authors = [
- {name="World Bank Data Lab", email="datalab@worldbank.org"},
-]
+description = "Package for measuring impact of and vulnerability to heatwaves created by the WB Data Lab"
+readme = { file = "README.md", content-type = "text/markdown" }
+license = { file = "LICENSE" }
+keywords = ["climate change", "heatwaves", "world bank"]
+authors = [{ name = "World Bank Data Lab", email = "datalab@worldbank.org" }]
maintainers = [
- {name="Sahiti Sarva", email="ssarva@worldbank.org"},
+ { name = "Sahiti Sarva", email = "ssarva@worldbank.org" },
+ { name = "Gabriel Stefanini Vicente", email = "gvicente@worldbank.org" },
]
classifiers = [
- "Programming Language :: Python :: 3",
+ "Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
@@ -27,15 +25,29 @@ classifiers = [
"Intended Audience :: Developers",
"Operating System :: OS Independent",
]
+dynamic = ["version"]
+
requires-python = ">=3.7"
-dependencies = []
[project.optional-dependencies]
-notebook = ["notebook>=6.5.2"]
-
+docs = [
+ "docutils==0.17.1", # https://jupyterbook.org/en/stable/content/citations.html?highlight=docutils#citations-and-bibliographies
+ "jupyter-book>=0.15.1",
+]
[project.urls]
"Homepage" = "https://github.com/datapartnership/heatwaves"
"Bug Reports" = "https://github.com/datapartnership/heatwaves/issues"
"Source" = "https://github.com/datapartnership/heatwaves"
-[tool.setuptools.dynamic]
-version = {attr = "heatwaves.__version__"}
\ No newline at end of file
+[tool.codespell]
+skip = './.git,docs/_build,docs/references.bib,*.py,*.R,*.png,*.gz,*.whl'
+ignore-regex = '^\s*"image\/png":\s.*'
+ignore-words-list = "gost,"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/heatwaves"]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
diff --git a/src/heatwaves/__init__.py b/src/heatwaves/__init__.py
index 1db78e9..95a70e5 100644
--- a/src/heatwaves/__init__.py
+++ b/src/heatwaves/__init__.py
@@ -3,4 +3,4 @@
logging.basicConfig(level=logging.INFO)
log = logging.getLogger(__name__)
-__version__="2023.07.1"
+__version__ = "2023.07.1"
diff --git a/src/heatwaves/geographic.py b/src/heatwaves/geographic.py
index 95b6084..93f1f32 100644
--- a/src/heatwaves/geographic.py
+++ b/src/heatwaves/geographic.py
@@ -1,6 +1,5 @@
def clip_area(ds, area):
-
ds.rio.write_crs("EPSG:4326", inplace=True)
- clipped_area = ds.rio.clip(area.geometry.values,all_touched=True, drop=True)
+ clipped_area = ds.rio.clip(area.geometry.values, all_touched=True, drop=True)
- return clipped_area
\ No newline at end of file
+ return clipped_area
diff --git a/src/heatwaves/weather.py b/src/heatwaves/weather.py
index 4ee7fbc..277c8fe 100644
--- a/src/heatwaves/weather.py
+++ b/src/heatwaves/weather.py
@@ -1,67 +1,88 @@
-
import math
from .geographic import *
+
def convert_kelvin_to_fahrenheit(k):
- return 1.8*(k-273.15) + 32
+ return 1.8 * (k - 273.15) + 32
+
def convert_celcius_to_fahrenheit(c):
- return 9*(c/5)+32
+ return 9 * (c / 5) + 32
+
def convert_fahrenheit_to_celcius(f):
- return (5/9)*(f-32)
-
+ return (5 / 9) * (f - 32)
def calculate_heat_index(T, RH):
## Taken from the NWS 2011 definition of a heatwave
- if T<=40:
+ if T <= 40:
return T
else:
- A = -10.3 + 1.1*T + 0.047*RH
- if A<79:
+ A = -10.3 + 1.1 * T + 0.047 * RH
+ if A < 79:
return A
else:
- B = -42.379+2.04901523*T + 10.14333127*RH -0.22475541*T*RH- .00683783*T*T - .05481717*RH*RH + .00122874*T*T*RH + .00085282*T*RH*RH - .00000199*T*T*RH*RH
- if RH <= 13 and T>=80 and T<=112:
- return B - (math.abs(13-RH)/4)*(math.sqrt((17-math.abs(T-95))/17))
- elif RH>85 and T>=80 and T<=87:
- return B + 0.02*(RH-85)*(87-T)
+ B = (
+ -42.379
+ + 2.04901523 * T
+ + 10.14333127 * RH
+ - 0.22475541 * T * RH
+ - 0.00683783 * T * T
+ - 0.05481717 * RH * RH
+ + 0.00122874 * T * T * RH
+ + 0.00085282 * T * RH * RH
+ - 0.00000199 * T * T * RH * RH
+ )
+ if RH <= 13 and T >= 80 and T <= 112:
+ return B - (math.abs(13 - RH) / 4) * (
+ math.sqrt((17 - math.abs(T - 95)) / 17)
+ )
+ elif RH > 85 and T >= 80 and T <= 87:
+ return B + 0.02 * (RH - 85) * (87 - T)
else:
return B
- #HI = -42.379 + 2.04901523*T + 10.14333127*RH - .22475541*T*RH - .00683783*T*T - .05481717*RH*RH + .00122874*T*T*RH + .00085282*T*RH*RH - .00000199*T*T*RH*RH
- #return HI
+ # HI = -42.379 + 2.04901523*T + 10.14333127*RH - .22475541*T*RH - .00683783*T*T - .05481717*RH*RH + .00122874*T*T*RH + .00085282*T*RH*RH - .00000199*T*T*RH*RH
+ # return HI
+
def combine_tmax_rh(tmax, rh):
- tmax=tmax.to_dask_dataframe()
- tmax['Tasmax_F'] = tmax['Tasmax'].apply(lambda x: convert_kelvin_to_fahrenheit(x), meta = ('Tasmax', 'float64'))
+ tmax = tmax.to_dask_dataframe()
+ tmax["Tasmax_F"] = tmax["Tasmax"].apply(
+ lambda x: convert_kelvin_to_fahrenheit(x), meta=("Tasmax", "float64")
+ )
rh = rh.to_dask_dataframe()
- hi = tmax.merge(rh, on = ['time', 'lat', 'lon'])
+ hi = tmax.merge(rh, on=["time", "lat", "lon"])
return hi
def classify_heat_index(x, t=0, rh=0):
- if x==103 and rh<95 and t>86 and t<90:
+ if x == 103 and rh < 95 and t > 86 and t < 90:
return 3
- elif x>125:
+ elif x > 125:
return 4
- elif x>=104:
+ elif x >= 104:
return 3
- elif x>90:
+ elif x > 90:
return 2
- elif x>80:
+ elif x > 80:
return 1
else:
return 0
-
+
+
def get_heat_index(ds_tasmax, ds_rh, shapefile):
tmax = clip_area(ds_tasmax, shapefile)
rh = clip_area(ds_rh, shapefile)
hi = combine_tmax_rh(tmax, rh)
- hi['heat_index'] = hi.apply(lambda x: calculate_heat_index(x['Tasmax_F'], x['RH_f_inst']), meta = (None, 'float64'), axis=1)
+ hi["heat_index"] = hi.apply(
+ lambda x: calculate_heat_index(x["Tasmax_F"], x["RH_f_inst"]),
+ meta=(None, "float64"),
+ axis=1,
+ )
hi = hi.compute()
- return hi
\ No newline at end of file
+ return hi