earth2studio/Makefile at main · NVIDIA/earth2studio · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
.PHONY: install
install:
	uv sync
	uv sync --extra all --extra aifs

.PHONY: install-docker
install-docker:
	uv pip install --system --break-system-packages .
	uv pip install --system --break-system-packages .[all] --group dev

.PHONY: setup-ci
setup-ci:
	uv venv --python=3.13
	uv sync
	uv run pre-commit install --install-hooks
	uv tool install tox --with tox-uv
	uv sync --extra all
	uv sync --extra aifs
	uv sync --extra aifs2
	uv sync --extra aifs2ens
	uv sync --extra aifsens
	uv sync --extra stormcast-conus

.PHONY: format
format:
	uv run pre-commit run black -a --show-diff-on-failure

.PHONY: black
black:
	uv run pre-commit run black -a --show-diff-on-failure

.PHONY: interrogate
interrogate:
	uv run pre-commit run interrogate -a

.PHONY: lint
lint:
	uv run pre-commit run check-added-large-files -a
	uv run pre-commit run trailing-whitespace -a
	uv run pre-commit run end-of-file-fixer -a
	uv run pre-commit run debug-statements -a
	uv run pre-commit run markdownlint -a
	uv run pre-commit run name-tests-test -a
	uv run pre-commit run pyupgrade -a --show-diff-on-failure
	uv run pre-commit run ruff -a
	uv run pre-commit run mypy -a

.PHONY: zizmor
zizmor:
	uv run pre-commit run zizmor -a

.PHONY: license
license:
	uv run python test/_license/header_check.py

.PHONY: pytest
pytest:
	@test -n "$(TOX_ENV)" || (echo "TOX_ENV is required! Usage: make pytest TOX_ENV=<env>" && exit 1)
	uvx tox -c tox.ini run -e $(TOX_ENV)

.PHONY: pytest-full
pytest-full:
	uvx tox -c tox.ini run -- --cov --cov-append --slow --package --testmon-noselect

# Select which pytest target to run in CI based on environment
ifneq (,$(filter 1 true TRUE True yes YES on ON,$(CI_PYTEST_ALL)))
PYTEST_CI_TARGET := pytest-full
else
PYTEST_CI_TARGET := pytest TOX_ENV=$(TOX_ENV)
endif

.PHONY: pytest-ci
pytest-ci:
	uv run python test/_ci/check_gpu.py || exit $?
	$(MAKE) $(PYTEST_CI_TARGET)

.PHONY: coverage
coverage:
	uv run coverage combine || true
	uv run coverage report --fail-under=90 || true

UV_DOCS := uv run --locked --group docs

.PHONY: docs-generate
docs-generate:
	$(UV_DOCS) python docs/generate_api.py
	$(UV_DOCS) python docs/generate_catalog.py
	$(UV_DOCS) python docs/generate_install_options.py
	$(UV_DOCS) python docs/generate_scorecard.py
	$(UV_DOCS) python docs/generate_gallery.py

.PHONY: docs
docs:
	uv sync --locked --group docs
	$(MAKE) docs-generate
	E2S_GALLERY_EXECUTE=never $(UV_DOCS) zensical build --clean
	rm -rf site/__pycache__ site/_build/html
	find site -maxdepth 1 -type f -name "*.py" -delete

.PHONY: docs-full
docs-full:
	uv sync --locked --group docs
	$(MAKE) docs-generate
	$(MAKE) docs-build-examples
	$(UV_DOCS) python docs/generate_gallery.py
	E2S_GALLERY_EXECUTE=never $(UV_DOCS) zensical build --clean
	rm -rf site/__pycache__ site/_build/html
	find site -maxdepth 1 -type f -name "*.py" -delete

.PHONY: docs-build-examples
docs-build-examples:
	test/_ci/build_docs_examples.sh

DOCS_JOBS ?= 1
.PHONY: docs-dev
docs-dev:
	uv sync --locked --group docs
	$(MAKE) docs-generate
	@if [ -n "$(FILENAME)" ]; then \
		$(UV_DOCS) e2s-gallery build "$(FILENAME)" --execute stale --jobs $(DOCS_JOBS); \
		$(UV_DOCS) python docs/generate_gallery.py; \
	fi
	E2S_GALLERY_EXECUTE=never $(UV_DOCS) zensical serve -a 0.0.0.0:$(PORT)

DOC_VERSION ?= main
.PHONY: docs-build-version
docs-build-version:
	uv sync --locked --group docs
	$(MAKE) docs-generate
	DOC_VERSION=$(DOC_VERSION) E2S_GALLERY_EXECUTE=never $(UV_DOCS) zensical build --clean
	rm -rf site/__pycache__ site/_build/html
	find site -maxdepth 1 -type f -name "*.py" -delete

.PHONY: docs-deploy-version
docs-deploy-version:
	$(MAKE) docs-build-version

.PHONY: docs-version-serve
docs-version-serve:
	uv sync --locked --group docs
	$(UV_DOCS) mike serve

PORT ?= 8001
.PHONY: docs-serve
docs-serve:
	uv sync --locked --group docs
	$(MAKE) docs-generate
	E2S_GALLERY_EXECUTE=never $(UV_DOCS) zensical serve -a 0.0.0.0:$(PORT)

.PHONY: container-service
# Example DOCKER_REPO?=nvcr.io/dycvht5ows21
E2S_RELEASE_TAG?=0.15.0
E2S_IMAGE_NAME=$(DOCKER_REPO)/earth2studio-scicomp
E2S_IMAGE_TAG=v$(E2S_RELEASE_TAG).20260514.0
container-service:
	@test -n "$(DOCKER_REPO)" || (echo "DOCKER_REPO is not set!" && exit 1)
	DOCKER_BUILDKIT=1 docker build -t $(E2S_IMAGE_NAME):$(E2S_IMAGE_TAG) -f serve/Dockerfile .