jcm 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. jcm-1.0.0/.coveragerc +3 -0
  2. jcm-1.0.0/.dockerignore +17 -0
  3. jcm-1.0.0/.github/pull_request_template.md +11 -0
  4. jcm-1.0.0/.github/workflows/run_docs.yaml +31 -0
  5. jcm-1.0.0/.github/workflows/run_linter.yaml +18 -0
  6. jcm-1.0.0/.github/workflows/run_test.yaml +44 -0
  7. jcm-1.0.0/.gitignore +173 -0
  8. jcm-1.0.0/.readthedocs.yaml +13 -0
  9. jcm-1.0.0/Dockerfile +28 -0
  10. jcm-1.0.0/JAX_gotchas.md +29 -0
  11. jcm-1.0.0/LICENSE +201 -0
  12. jcm-1.0.0/PKG-INFO +23 -0
  13. jcm-1.0.0/README.md +142 -0
  14. jcm-1.0.0/conftest.py +9 -0
  15. jcm-1.0.0/docker-compose.yml +31 -0
  16. jcm-1.0.0/docs/Makefile +20 -0
  17. jcm-1.0.0/docs/README.md +109 -0
  18. jcm-1.0.0/docs/generate_docs.py +128 -0
  19. jcm-1.0.0/docs/make.bat +35 -0
  20. jcm-1.0.0/docs/source/_templates/autosummary/class.rst +64 -0
  21. jcm-1.0.0/docs/source/api.rst +13 -0
  22. jcm-1.0.0/docs/source/conf.py +35 -0
  23. jcm-1.0.0/docs/source/design.rst +272 -0
  24. jcm-1.0.0/docs/source/developer.rst +195 -0
  25. jcm-1.0.0/docs/source/getting_started.rst +232 -0
  26. jcm-1.0.0/docs/source/index.rst +25 -0
  27. jcm-1.0.0/docs/source/speedy_physics.rst +607 -0
  28. jcm-1.0.0/docs/source/speedy_translation.rst +373 -0
  29. jcm-1.0.0/jcm/__init__.py +1 -0
  30. jcm-1.0.0/jcm/config/config.yaml +11 -0
  31. jcm-1.0.0/jcm/config/hydra/help/custom_help.yaml +32 -0
  32. jcm-1.0.0/jcm/config/model/default.yaml +4 -0
  33. jcm-1.0.0/jcm/constants.py +5 -0
  34. jcm-1.0.0/jcm/data/__init__.py +0 -0
  35. jcm-1.0.0/jcm/data/bc/__init__.py +0 -0
  36. jcm-1.0.0/jcm/data/bc/compile.py +88 -0
  37. jcm-1.0.0/jcm/data/bc/compile_test.py +9 -0
  38. jcm-1.0.0/jcm/data/bc/interpolate.py +144 -0
  39. jcm-1.0.0/jcm/data/bc/interpolate_test.py +9 -0
  40. jcm-1.0.0/jcm/data/bc/t30/anom/sea_surface_temperature_anomaly.nc +0 -0
  41. jcm-1.0.0/jcm/data/bc/t30/clim/forcing.nc +0 -0
  42. jcm-1.0.0/jcm/data/bc/t30/clim/land.nc +0 -0
  43. jcm-1.0.0/jcm/data/bc/t30/clim/sea_ice.nc +0 -0
  44. jcm-1.0.0/jcm/data/bc/t30/clim/sea_surface_temperature.nc +0 -0
  45. jcm-1.0.0/jcm/data/bc/t30/clim/snow.nc +0 -0
  46. jcm-1.0.0/jcm/data/bc/t30/clim/soil.nc +0 -0
  47. jcm-1.0.0/jcm/data/bc/t30/clim/surface.nc +0 -0
  48. jcm-1.0.0/jcm/data/bc/t30/clim/terrain.nc +0 -0
  49. jcm-1.0.0/jcm/data/test/cbmf.npy +0 -0
  50. jcm-1.0.0/jcm/data/test/dfqa.npy +0 -0
  51. jcm-1.0.0/jcm/data/test/dfse.npy +0 -0
  52. jcm-1.0.0/jcm/data/test/iptop.npy +0 -0
  53. jcm-1.0.0/jcm/data/test/precnv.npy +0 -0
  54. jcm-1.0.0/jcm/data/test/qdif.npy +0 -0
  55. jcm-1.0.0/jcm/data/test/t30/default_statistics.nc +0 -0
  56. jcm-1.0.0/jcm/data/test/t30/generate_default_stats.py +44 -0
  57. jcm-1.0.0/jcm/date.py +76 -0
  58. jcm-1.0.0/jcm/date_test.py +40 -0
  59. jcm-1.0.0/jcm/diffusion.py +27 -0
  60. jcm-1.0.0/jcm/dynamics_units_table.csv +7 -0
  61. jcm-1.0.0/jcm/forcing.py +152 -0
  62. jcm-1.0.0/jcm/geometry.py +253 -0
  63. jcm-1.0.0/jcm/geometry_test.py +126 -0
  64. jcm-1.0.0/jcm/main.py +38 -0
  65. jcm-1.0.0/jcm/model.py +538 -0
  66. jcm-1.0.0/jcm/model_test.py +300 -0
  67. jcm-1.0.0/jcm/physics/__init__.py +0 -0
  68. jcm-1.0.0/jcm/physics/held_suarez/__init__.py +0 -0
  69. jcm-1.0.0/jcm/physics/held_suarez/held_suarez_physics.py +103 -0
  70. jcm-1.0.0/jcm/physics/held_suarez/held_suarez_test.py +40 -0
  71. jcm-1.0.0/jcm/physics/speedy/__init__.py +0 -0
  72. jcm-1.0.0/jcm/physics/speedy/convection.py +236 -0
  73. jcm-1.0.0/jcm/physics/speedy/convection_test.py +292 -0
  74. jcm-1.0.0/jcm/physics/speedy/forcing.py +39 -0
  75. jcm-1.0.0/jcm/physics/speedy/humidity.py +101 -0
  76. jcm-1.0.0/jcm/physics/speedy/humidity_test.py +281 -0
  77. jcm-1.0.0/jcm/physics/speedy/large_scale_condensation.py +85 -0
  78. jcm-1.0.0/jcm/physics/speedy/large_scale_condensation_test.py +141 -0
  79. jcm-1.0.0/jcm/physics/speedy/longwave_radiation.py +226 -0
  80. jcm-1.0.0/jcm/physics/speedy/longwave_radiation_test.py +286 -0
  81. jcm-1.0.0/jcm/physics/speedy/orographic_correction.py +293 -0
  82. jcm-1.0.0/jcm/physics/speedy/orographic_correction_test.py +605 -0
  83. jcm-1.0.0/jcm/physics/speedy/params.py +294 -0
  84. jcm-1.0.0/jcm/physics/speedy/physical_constants.py +50 -0
  85. jcm-1.0.0/jcm/physics/speedy/physics_data.py +525 -0
  86. jcm-1.0.0/jcm/physics/speedy/shortwave_radiation.py +456 -0
  87. jcm-1.0.0/jcm/physics/speedy/shortwave_radiation_test.py +574 -0
  88. jcm-1.0.0/jcm/physics/speedy/speedy_physics.py +135 -0
  89. jcm-1.0.0/jcm/physics/speedy/speedy_physics_test.py +22 -0
  90. jcm-1.0.0/jcm/physics/speedy/surface_flux.py +304 -0
  91. jcm-1.0.0/jcm/physics/speedy/surface_flux_test.py +611 -0
  92. jcm-1.0.0/jcm/physics/speedy/test_utils.py +17 -0
  93. jcm-1.0.0/jcm/physics/speedy/units_table.csv +74 -0
  94. jcm-1.0.0/jcm/physics/speedy/vertical_diffusion.py +137 -0
  95. jcm-1.0.0/jcm/physics/speedy/vertical_diffusion_test.py +106 -0
  96. jcm-1.0.0/jcm/physics_interface.py +415 -0
  97. jcm-1.0.0/jcm/physics_interface_test.py +63 -0
  98. jcm-1.0.0/jcm/utils.py +146 -0
  99. jcm-1.0.0/jcm.egg-info/PKG-INFO +23 -0
  100. jcm-1.0.0/jcm.egg-info/SOURCES.txt +109 -0
  101. jcm-1.0.0/jcm.egg-info/dependency_links.txt +1 -0
  102. jcm-1.0.0/jcm.egg-info/requires.txt +9 -0
  103. jcm-1.0.0/jcm.egg-info/top_level.txt +1 -0
  104. jcm-1.0.0/logo.png +0 -0
  105. jcm-1.0.0/notebooks/01_jcm_demo.ipynb +3941 -0
  106. jcm-1.0.0/notebooks/02_optimization_example.ipynb +280 -0
  107. jcm-1.0.0/notebooks/03_generate_speedy_default_stats.ipynb +203 -0
  108. jcm-1.0.0/notebooks/jcm_scaling.png +0 -0
  109. jcm-1.0.0/pyproject.toml +55 -0
  110. jcm-1.0.0/requirements.txt +16 -0
  111. jcm-1.0.0/setup.cfg +4 -0
jcm-1.0.0/.coveragerc ADDED
@@ -0,0 +1,3 @@
1
+ [run]
2
+ omit =
3
+ *_test.py
@@ -0,0 +1,17 @@
1
+ # Python artifacts
2
+ __pycache__/
3
+ *.py[cod]
4
+ *.pyo
5
+ *.pyd
6
+ *.egg-info/
7
+ .eggs/
8
+ .pytest_cache/
9
+
10
+ # Build artifacts
11
+ build/
12
+ docs/build/
13
+ docs/source/generated/
14
+
15
+ # Git and CI
16
+ .github/
17
+ .vscode/
@@ -0,0 +1,11 @@
1
+ ## Describe your changes
2
+
3
+ ## Issue ticket number and link
4
+
5
+ ## Checklist before requesting a review
6
+ - [ ] I have performed a self-review of my code
7
+ - [ ] My code follows the style guidelines of this project
8
+ - [ ] I have commented my code, particularly in hard-to-understand areas
9
+ - [ ] I have made corresponding changes to the documentation
10
+ - [ ] I have added tests that prove my fix is effective or that my feature works
11
+ - [ ] New and existing unit tests pass locally with my changes
@@ -0,0 +1,31 @@
1
+ name: Update Documentation
2
+ on:
3
+ push:
4
+ paths:
5
+ - 'jcm/physics/speedy/units_table.csv'
6
+ workflow_dispatch:
7
+
8
+ permissions:
9
+ contents: write
10
+
11
+ jobs:
12
+ update-docs:
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - uses: actions/checkout@v3
16
+
17
+ - name: Set up Python
18
+ uses: actions/setup-python@v4
19
+ with:
20
+ python-version: '3.x'
21
+
22
+ - name: Update Sphinx documentation
23
+ run: python docs/generate_docs.py
24
+
25
+ - name: Commit changes
26
+ run: |
27
+ git config --local user.email "action@github.com"
28
+ git config --local user.name "GitHub Action"
29
+ git add docs/source/speedy_translation.rst
30
+ git diff --staged --quiet || git commit -m "Auto-update variable translation documentation"
31
+ git push
@@ -0,0 +1,18 @@
1
+ name: Linting via Ruff
2
+
3
+ on: [push]
4
+
5
+ jobs:
6
+ lint:
7
+ runs-on: ubuntu-latest
8
+ steps:
9
+ - uses: actions/checkout@v3
10
+ - name: Set up Python
11
+ uses: actions/setup-python@v4
12
+ with:
13
+ python-version: "3.11"
14
+ - name: Install Ruff
15
+ run: pip install ruff
16
+ - name: Run Ruff
17
+ run: ruff check .
18
+ continue-on-error: false
@@ -0,0 +1,44 @@
1
+ name: Run Unit Tests via Pytest
2
+
3
+ on:
4
+ push:
5
+ pull_request:
6
+
7
+ concurrency:
8
+ # For pull requests: group by PR number
9
+ # For branch pushes: group by branch name
10
+ group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.event.pull_request.number || github.ref_name }}
11
+ cancel-in-progress: true
12
+
13
+ jobs:
14
+ build:
15
+ runs-on: ubuntu-latest
16
+ strategy:
17
+ matrix:
18
+ python-version: ["3.11"]
19
+
20
+ steps:
21
+ - uses: actions/checkout@v3
22
+
23
+ - name: Set up Python ${{ matrix.python-version }}
24
+ uses: actions/setup-python@v4
25
+ with:
26
+ python-version: ${{ matrix.python-version }}
27
+
28
+ - name: Install dependencies
29
+ run: |
30
+ python -m pip install --upgrade pip
31
+ if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
32
+ pip install -e .
33
+
34
+ # run fast tests when triggered by a push
35
+ - name: Test with pytest (no slow tests on push)
36
+ if: github.event_name == 'push'
37
+ run: |
38
+ pytest -v -s -m "not slow" --cov=jcm --cov-fail-under=90
39
+
40
+ # run slow tests when triggered by a push to an open PR
41
+ - name: Test with pytest (include slow tests on PR)
42
+ if: github.event_name == 'pull_request'
43
+ run: |
44
+ pytest -v -s -m "slow" --cov=jcm --cov-fail-under=80
jcm-1.0.0/.gitignore ADDED
@@ -0,0 +1,173 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+ jcm/outputs
29
+
30
+ # PyInstaller
31
+ # Usually these files are written by a python script from a template
32
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
33
+ *.manifest
34
+ *.spec
35
+
36
+ # Installer logs
37
+ pip-log.txt
38
+ pip-delete-this-directory.txt
39
+
40
+ # Unit test / coverage reports
41
+ htmlcov/
42
+ .tox/
43
+ .nox/
44
+ .coverage
45
+ .coverage.*
46
+ .cache
47
+ nosetests.xml
48
+ coverage.xml
49
+ *.cover
50
+ *.py,cover
51
+ .hypothesis/
52
+ .pytest_cache/
53
+ cover/
54
+
55
+ # Translations
56
+ *.mo
57
+ *.pot
58
+
59
+ # Django stuff:
60
+ *.log
61
+ local_settings.py
62
+ db.sqlite3
63
+ db.sqlite3-journal
64
+
65
+ # Flask stuff:
66
+ instance/
67
+ .webassets-cache
68
+
69
+ # Scrapy stuff:
70
+ .scrapy
71
+
72
+ # Sphinx documentation
73
+ docs/_build/
74
+
75
+ # PyBuilder
76
+ .pybuilder/
77
+ target/
78
+
79
+ # Jupyter Notebook
80
+ .ipynb_checkpoints
81
+
82
+ # IPython
83
+ profile_default/
84
+ ipython_config.py
85
+
86
+ # pyenv
87
+ # For a library or package, you might want to ignore these files since the code is
88
+ # intended to run in multiple environments; otherwise, check them in:
89
+ # .python-version
90
+
91
+ # pipenv
92
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
94
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
95
+ # install all needed dependencies.
96
+ #Pipfile.lock
97
+
98
+ # poetry
99
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
100
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
101
+ # commonly ignored for libraries.
102
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
103
+ #poetry.lock
104
+
105
+ # pdm
106
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
107
+ #pdm.lock
108
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
109
+ # in version control.
110
+ # https://pdm.fming.dev/latest/usage/project/#working-with-version-control
111
+ .pdm.toml
112
+ .pdm-python
113
+ .pdm-build/
114
+
115
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
116
+ __pypackages__/
117
+
118
+ # Celery stuff
119
+ celerybeat-schedule
120
+ celerybeat.pid
121
+
122
+ # SageMath parsed files
123
+ *.sage.py
124
+
125
+ # Environments
126
+ .env
127
+ .venv
128
+ env/
129
+ venv/
130
+ ENV/
131
+ env.bak/
132
+ venv.bak/
133
+
134
+ # Spyder project settings
135
+ .spyderproject
136
+ .spyproject
137
+
138
+ # Rope project settings
139
+ .ropeproject
140
+
141
+ # mkdocs documentation
142
+ /site
143
+
144
+ # mypy
145
+ .mypy_cache/
146
+ .dmypy.json
147
+ dmypy.json
148
+
149
+ # Pyre type checker
150
+ .pyre/
151
+
152
+ # pytype static type analyzer
153
+ .pytype/
154
+
155
+ # Cython debug symbols
156
+ cython_debug/
157
+
158
+ # IDE folders
159
+ .idea/
160
+ .vscode/
161
+
162
+ #MacOS files
163
+ .DS_Store
164
+ notebooks/model_state.nc
165
+
166
+ # NetCDF files
167
+ *.nc
168
+
169
+ docs/build
170
+ docs/source/generated
171
+
172
+ # Claude files
173
+ CLAUDE.md
@@ -0,0 +1,13 @@
1
+ version: 2
2
+
3
+ build:
4
+ os: ubuntu-24.04
5
+ tools:
6
+ python: "3.11"
7
+
8
+ sphinx:
9
+ configuration: docs/source/conf.py
10
+
11
+ python:
12
+ install:
13
+ - requirements: requirements.txt
jcm-1.0.0/Dockerfile ADDED
@@ -0,0 +1,28 @@
1
+ FROM python:3.11-slim
2
+
3
+ # Install dependencies
4
+ RUN apt-get update && apt-get install -y \
5
+ git \
6
+ curl \
7
+ build-essential \
8
+ libopenblas-dev \
9
+ liblapack-dev \
10
+ libffi-dev \
11
+ libglib2.0-0 \
12
+ libsm6 \
13
+ libxext6 \
14
+ libxrender-dev \
15
+ && rm -rf /var/lib/apt/lists/*
16
+
17
+ WORKDIR /app
18
+
19
+ COPY requirements.txt .
20
+ RUN pip install --upgrade pip setuptools wheel
21
+ RUN pip install --no-cache-dir -r requirements.txt
22
+
23
+ COPY . /app
24
+ RUN pip install -e .
25
+
26
+ RUN pip install --upgrade "jax[tpu]" -f https://storage.googleapis.com/jax-releases/libtpu_releases.html
27
+
28
+ CMD ["bash"]
@@ -0,0 +1,29 @@
1
+
2
+ # JAX Gotchas
3
+
4
+ ## VMap
5
+
6
+ When using `vmap` in JAX, there are some gotchas to be aware of. One common issue is with scalar values that are looped over using `vmap`. In such cases, `vmap` treats the scalar as a vector, which can lead to unexpected behavior.
7
+
8
+ For example: in the original code we passed in one element of a vector called sig and checked its value. When vectorizing over the same function with `vmap` the comparison `sig <= 0.0` because `vmap` considers `sig` as a vector, even though conceptually is a scalar. To work around this, you can use alternative approaches like `jnp.less_equal` or `jnp.where` to handle the comparison correctly.
9
+
10
+ Here's an updated version of the code snippet:
11
+ `qsat = jnp.where(sig <= 0.0, 622.0 * qsat / (ps[0,0] - 0.378 * qsat), 622.0 * qsat / (sig * ps - 0.378 * qsat))`
12
+
13
+ ## If/else statements
14
+
15
+ We can't have traditional if/else statements that depend on jax types. The solution is fairly straightforward, it requires the use of jax.lax.cond(). This requires you to write a function to execute if the conditional is true and a function to execute if it is false. There is an option to pass an operand to both functions (i.e. a tuple, array, etc). Example use cases can be found in surface_flux.py (this works for both forward passes of the function and gradients).
16
+
17
+ ```
18
+ flag = True
19
+ def pass_fun(operand):
20
+ return operand
21
+
22
+ def update_fun(operand):
23
+ t, s, u, v = operand
24
+ # some operations inserted here
25
+
26
+ return (t,s,u,v)
27
+
28
+ t,s,u,v = jax.lax.cond(flag, update_fun, pass_fun, operand=(t,s,u,v))
29
+ ```
jcm-1.0.0/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
jcm-1.0.0/PKG-INFO ADDED
@@ -0,0 +1,23 @@
1
+ Metadata-Version: 2.4
2
+ Name: jcm
3
+ Version: 1.0.0
4
+ Summary: JAX-based General Circulation Model
5
+ Author-email: dwatsonparris@ucsd.edu
6
+ License: Apache
7
+ Keywords: climate,machine-learning
8
+ Classifier: Development Status :: 3 - Alpha
9
+ Classifier: Topic :: Scientific/Engineering
10
+ Classifier: Intended Audience :: Science/Research
11
+ Classifier: License :: OSI Approved :: Apache Software License
12
+ Requires-Python: >=3.11
13
+ License-File: LICENSE
14
+ Requires-Dist: dinosaur
15
+ Requires-Dist: flax
16
+ Requires-Dist: jax-datetime
17
+ Requires-Dist: tree-math
18
+ Requires-Dist: hydra-core
19
+ Requires-Dist: xarray[io,parallel]
20
+ Requires-Dist: pytest-cov
21
+ Requires-Dist: sphinx
22
+ Requires-Dist: furo
23
+ Dynamic: license-file