makefile

.DEFAULT: help

help:
	@echo "install"
	@echo "        Install curvlinops and dependencies"
	@echo "uninstall"
	@echo "        Uninstall curvlinops"
	@echo "lint"
	@echo "        Run all linting actions"
	@echo "docs"
	@echo "        Build the documentation"
	@echo "install-dev"
	@echo "        Install curvlinops and development tools"
	@echo "install-docs"
	@echo "        Install curvlinops and documentation tools"
	@echo "install-test"
	@echo "        Install curvlinops and testing tools"
	@echo "test-light"
	@echo "        Run pytest on the light part of project and report coverage"
	@echo "test"
	@echo "        Run pytest on test and report coverage"
	@echo "install-lint"
	@echo "        Install curvlinops and the linter tools"
	@echo "ruff-format"
	@echo "        Run ruff format on the project"
	@echo "ruff-format-check"
	@echo "        Check if ruff format would change files"
	@echo "ruff"
	@echo "        Run ruff on the project and fix errors"
	@echo "ruff-check"
	@echo "        Run ruff check on the project without fixing errors"
	@echo "conda-env"
	@echo "        Create conda environment 'curvlinops' with dev setup"
	@echo "darglint-check"
	@echo "        Run darglint (docstring check) on the project"
	@echo "pydocstyle-check"
	@echo "        Run pydocstyle (docstring check) on the project"

.PHONY: install

install:
	@pip install -e .

.PHONY: uninstall

uninstall:
	@pip uninstall curvlinops-for-pytorch

.PHONY: docs

docs:
	@cd docs/rtd && make html
	@echo "\nOpen docs/rtd/index.html to see the result."

.PHONY: install-dev

install-dev: install-lint install-test install-docs

.PHONY: install-docs

install-docs:
	@pip install -e .[docs]

.PHONY: install-test

install-test:
	@pip install -e .[test]

.PHONY: test test-light

test:
	@pytest -vx --run-optional-tests=montecarlo --cov=curvlinops --doctest-modules curvlinops test

test-light:
	@pytest -vx --cov=curvlinops --doctest-modules curvlinops test

.PHONY: install-lint

install-lint:
	@pip install -e .[lint]

.PHONY: ruff-format ruff-format-check

ruff-format:
	@ruff format .

ruff-format-check:
	@ruff format --check .

.PHONY: ruff-check

ruff:
	@ruff check . --fix

ruff-check:
	@ruff check .

.PHONY: darglint-check

darglint-check:
	@darglint --verbosity 2 curvlinops

.PHONY: pydocstyle-check

pydocstyle-check:
	@pydocstyle --count .

.PHONY: conda-env

conda-env:
	@conda env create --file .conda_env.yml

.PHONY: lint

lint:
	make ruff-format-check
	make ruff-check
	make darglint-check
	make pydocstyle-check