Makefile

# Makefile with some convenient quick ways to do common things

PROJECT=magic-cta-pipe
PYTHON=python

help:
	@echo ''
	@echo '$(PROJECT) available make targets:'
	@echo ''
	@echo '  help         Print this help message (the default)'
	@echo '  env          Create a conda environment for magic-cta-pipe development'
	@echo '  develop      make symlinks to this package in python install dir'
	@echo '  clean        Remove temp files'
	@echo '  test         Run tests'
	@echo '  doc          Generate Sphinx docs'
	@echo '  analyze      Do a static code check and report errors'
	@echo ''
	@echo 'Advanced targets (for experts)'
	@echo '  conda        Build a conda package for distribution'
	@echo '  doc-publish  Upload docs to static GitHub page'
	@echo ''

init:
	@echo "'make init' is no longer needed"

clean:
	$(RM) -rf build docs/_build docs/api htmlcov magic_cta_pipe.egg-info dist
	find . -name "*.pyc" -exec rm {} \;
	find . -name "*.so" -exec rm {} \;
	find . -name __pycache__ | xargs rm -fr

test:
	pytest

doc:
	cd docs && $(MAKE) html SPHINXOPTS="-W --keep-going -n --color -j 1"
	@echo "------------------------------------------------"
	@echo "Documentation is in: docs/_build/html/index.html"

doc-publish:
	ghp-import -n -p -m 'Update gh-pages docs' docs/_build/html

analyze:
	@pylint magicctapipe --ignored-classes=astropy.units

lint:
	@flake8 magicctapipe

env:
	conda env create -n magic-lst -f environment.yml
	source activate magic-lst

develop:
	pip install -e .

wheel:
	python -m build --wheel

sdist:
	python -m build --sdist

trailing-spaces:
	find $(PROJECT) examples docs -name "*.py" -exec perl -pi -e 's/[ \t]*$$//' {} \;