Skip to content

Commit

Permalink
added a makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
blaylockbk committed Mar 1, 2023
1 parent c842f23 commit 1fc9c3b
Showing 1 changed file with 91 additions and 0 deletions.
91 changes: 91 additions & 0 deletions makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
#* Note: Comments that start with ## before a command will be used as help
#* documentation when someone types `make help`

## Install Herbie into current virtual environment
install:
pip install -e .

## Format files using Black
format:
black .

## Pull updates from main branch
pull:
git pull origin main

## Create a new conda environment `herbie`
conda-create:
conda env create -f environment.yml

## Update the `herbie` conda environment
conda-update:
conda env update -f environment.yml --prune

## Remove the `herbie` conda environment
conda-remove:
conda env remove --name herbie

## Clean the current conda environment
conda-clean:
conda clean -tp

###############################################################################
# Self Documenting Commands
###############################################################################
# From https://github.com/duarteocarmo/boilerplate/blob/master/Makefile
# See also: https://duarteocarmo.com/blog/opinionated-python-boilerplate

.DEFAULT_GOAL := help

# Inspired by <http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html>
# sed script explained:
# /^##/:
# * save line in hold space
# * purge line
# * Loop:
# * append newline + line to hold space
# * go to next line
# * if line starts with doc comment, strip comment character off and loop
# * remove target prerequisites
# * append hold space (+ newline) to line
# * replace newline plus comments by `---`
# * print line
# Separate expressions are necessary because labels cannot be delimited by
# semicolon; see <http://stackoverflow.com/a/11799865/1968>
.PHONY: help
help:
@echo "$$(tput bold)Available commands:$$(tput sgr0)"
@sed -n -e "/^## / { \
h; \
s/.*//; \
:doc" \
-e "H; \
n; \
s/^## //; \
t doc" \
-e "s/:.*//; \
G; \
s/\\n## /---/; \
s/\\n/ /g; \
p; \
}" ${MAKEFILE_LIST} \
| awk -F '---' \
-v ncol=$$(tput cols) \
-v indent=19 \
-v col_on="$$(tput setaf 6)" \
-v col_off="$$(tput sgr0)" \
'{ \
printf "%s%*s%s ", col_on, -indent, $$1, col_off; \
n = split($$2, words, " "); \
line_length = ncol - indent; \
for (i = 1; i <= n; i++) { \
line_length -= length(words[i]) + 1; \
if (line_length <= 0) { \
line_length = ncol - indent - length(words[i]) - 1; \
printf "\n%*s ", -indent, " "; \
} \
printf "%s ", words[i]; \
} \
printf "\n"; \
}' \
| more $(shell test $(shell uname) = Darwin && echo '--no-init --raw-control-chars')

0 comments on commit 1fc9c3b

Please sign in to comment.