From 06afe52a9f2ce31cb328afb0739ddc626addf9bf Mon Sep 17 00:00:00 2001 From: "W. Andre Perkins" Date: Tue, 8 Oct 2024 16:22:30 -0700 Subject: [PATCH] Update for PyPI release (#20) Updates for releases to PyPI. Includes move to pyproject.toml the current suggested format for package configuration over setup.py. Includes some deployment makefile targets for test/production. https://test.pypi.org/project/fme Resolves #14 * Update setup.py * Working pypi upload * Deploy targets in makefile * Update workflows * Pin torch-harmonics and min xarray version * Working tests * Fix find packages * Fix packaging * omit scripts and docs * Move pyproject.toml into fme folder * Remove extra versions.py * Remove version test * Linting * Adjust version to 2023.12.1 to match release * Fix environment creation * Change version to last PR date Sept 2024 * README typo --- Makefile | 14 +++ fme/LICENSE | 201 ++++++++++++++++++++++++++++++++++++ fme/README.md | 26 ++++- fme/deploy-requirements.txt | 2 + fme/fme/__init__.py | 2 +- fme/fme/core/version.py | 1 - fme/fme/test_version.py | 5 - fme/pyproject.toml | 35 +++++++ fme/requirements.txt | 2 +- fme/setup.py | 42 -------- 10 files changed, 278 insertions(+), 52 deletions(-) create mode 100644 fme/LICENSE create mode 100644 fme/deploy-requirements.txt delete mode 100644 fme/fme/core/version.py delete mode 100644 fme/fme/test_version.py create mode 100644 fme/pyproject.toml delete mode 100644 fme/setup.py diff --git a/Makefile b/Makefile index 671b411..0ff16ed 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,7 @@ VERSION ?= $(shell git rev-parse --short HEAD) IMAGE ?= fme ENVIRONMENT_NAME ?= fme +DEPLOY_TARGET ?= pypi build_docker_image: docker build -f docker/Dockerfile -t $(IMAGE):$(VERSION) . @@ -16,3 +17,16 @@ create_environment: test: pytest --durations 20 . + +# For maintainer use only +# requires fme[deploy] to be installed + +build_pypi: + rm -rf fme/dist + cd fme && python -m build + +deploy_pypi: build_pypi + cd fme && twine upload --repository $(DEPLOY_TARGET) dist/* + +deploy_test_pypi: DEPLOY_TARGET = testpypi +deploy_test_pypi: deploy_pypi diff --git a/fme/LICENSE b/fme/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/fme/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/fme/README.md b/fme/README.md index 7691e8d..397aeb1 100644 --- a/fme/README.md +++ b/fme/README.md @@ -1,2 +1,24 @@ -This python package is intended for use in the training and evaluation of -machine learning models that emulate weather and climate data. \ No newline at end of file +[![Docs](https://readthedocs.org/projects/ai2-climate-emulator/badge/?version=latest)](https://ai2-climate-emulator.readthedocs.io/en/latest/) + +# FME: Weather/Climate Model Emulation +This package contains code to train and evaluate weather/climate model emulators as seen in +"ACE: A fast, skillful learned global atmospheric model for climate prediction" ([arxiv:2310.02074](https://arxiv.org/abs/2310.02074)) +and "Application of the Ai2 Climate Emulator to E3SMv2's global atmosphere model, with a focus on precipitation fidelity" +([JGR-ML](https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2024JH000136)). + + +## Installation + +The package can be installed via PyPI using: + +``` +pip install fme +``` + +## Quickstart + +A quickstart guide may be found [here](https://ai2-climate-emulator.readthedocs.io/en/latest/quickstart.html). + +## Documentation + +See complete documentation [here](https://ai2-climate-emulator.readthedocs.io/en/latest/). diff --git a/fme/deploy-requirements.txt b/fme/deploy-requirements.txt new file mode 100644 index 0000000..51e16c7 --- /dev/null +++ b/fme/deploy-requirements.txt @@ -0,0 +1,2 @@ +build +twine \ No newline at end of file diff --git a/fme/fme/__init__.py b/fme/fme/__init__.py index d797337..7e7b693 100644 --- a/fme/fme/__init__.py +++ b/fme/fme/__init__.py @@ -1,4 +1,4 @@ -__version__ = "0.2.0" +__version__ = "2024.9.0" import torch_harmonics diff --git a/fme/fme/core/version.py b/fme/fme/core/version.py deleted file mode 100644 index d3ec452..0000000 --- a/fme/fme/core/version.py +++ /dev/null @@ -1 +0,0 @@ -__version__ = "0.2.0" diff --git a/fme/fme/test_version.py b/fme/fme/test_version.py deleted file mode 100644 index 7fca81f..0000000 --- a/fme/fme/test_version.py +++ /dev/null @@ -1,5 +0,0 @@ -import fme - - -def test_version(): - assert fme.__version__ == "0.2.0" diff --git a/fme/pyproject.toml b/fme/pyproject.toml new file mode 100644 index 0000000..165f261 --- /dev/null +++ b/fme/pyproject.toml @@ -0,0 +1,35 @@ +[build-system] +requires = ["setuptools", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "fme" +description = "Train and evaluate weather/climate model emulators" +readme = "README.md" +requires-python = ">=3.9" +license = {file = "LICENSE"} +authors = [ + {name = "Ai2 Climate Modeling", email = "climate-public-maintainer@allenai.org"} +] +keywords = ["weather", "climate", "machine learning", "emulation"] +classifiers = [ + "Intended Audience :: Science/Research", + "Development Status :: 4 - Beta", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python :: 3", + "Topic :: Scientific/Engineering :: Artificial Intelligence" +] +dynamic = ["dependencies", "optional-dependencies", "version"] +[project.urls] +Homepage = "https://github.com/ai2cm/ace" +Documentation = "https://ai2-climate-emulator.readthedocs.io/" + +[tool.setuptools.dynamic] +version = {attr = "fme.__version__"} +dependencies = { file = "requirements.txt" } +optional-dependencies.dev = { file = "dev-requirements.txt" } +optional-dependencies.docs = { file = "docs/requirements.txt" } +optional-dependencies.deploy = { file = "deploy-requirements.txt" } + +[tool.setuptools.packages] +find = {} diff --git a/fme/requirements.txt b/fme/requirements.txt index e67f0b8..587ce0b 100644 --- a/fme/requirements.txt +++ b/fme/requirements.txt @@ -9,7 +9,7 @@ tensorly-torch xarray dacite torch -torch-harmonics@git+https://github.com/NVIDIA/torch-harmonics.git@8826246cacf6c37b600cdd63fde210815ba238fd +torch-harmonics==0.6.2 zarr gcsfs s3fs diff --git a/fme/setup.py b/fme/setup.py deleted file mode 100644 index 30e1cde..0000000 --- a/fme/setup.py +++ /dev/null @@ -1,42 +0,0 @@ -from setuptools import find_packages, setup - - -def read_requirements(filename: str): - with open(filename) as requirements_file: - requirements = [] - for line in requirements_file: - line = line.strip() - if line.startswith("#") or len(line) == 0: - continue - requirements.append(line) - return requirements - - -setup( - name="fme", - version="0.2.0", - description="", - long_description=open("README.md").read(), - long_description_content_type="text/markdown", - classifiers=[ - "Intended Audience :: Science/Research", - "Development Status :: 3 - Alpha", - "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python :: 3", - "Topic :: Scientific/Engineering :: Artificial Intelligence", - ], - keywords="", - url="https://github.com/ai2cm/ace", - author="Allen Institute for Artificial Intelligence", - author_email="oliverwm@allenai.org", - license="Apache", - packages=find_packages( - exclude=["*.tests", "*.tests.*", "tests.*", "tests"], - ), - install_requires=read_requirements("requirements.txt"), - extras_require={ - "dev": read_requirements("dev-requirements.txt"), - "docs": read_requirements("docs/requirements.txt"), - }, - python_requires=">=3.8", -)