RFC: Disable precompilation to avoid memory spike (#38)

* Disable precompilation to avoid memory spike

* Make __precompile__(false) optional

* Bump version to 0.3.7

Author: mortenpi

Project.toml

@@ -1,7 +1,7 @@
 name = "CompactBases"
 uuid = "2c0377a8-7469-4ebd-be0f-82e501f20078"
 authors = ["Stefanos Carlström <[email protected]>"]
-version = "0.3.6"
+version = "0.3.7"
 
 [deps]
 BandedMatrices = "aae01518-5342-5314-be14-df237901396f"

src/CompactBases.jl

@@ -1,4 +1,21 @@
 module CompactBases
+# The package does support precompilation, but doing `using CompactBases` with
+# precompilation on can lead to a huge spike in memory. That does not happen if disable
+# precompilation for CompactBases with __precompile__(false).
+#
+# So, if this is a problem for the user, it is possible to disable precompilation by setting
+# the COMPACTBASES_NO_PRECOMPILE environment variable. E.g. the user can set it when
+# launching Julia by doing
+#
+#     COMPACTBASES_NO_PRECOMPILE= julia
+#
+# or set it in the ~/.julia/config/startup.jl file by setting
+#
+#     ENV["COMPACTBASES_NO_PRECOMPILE"] = ""
+#
+# Note that any value will do, even an empty string, as only the presence of the variable is
+# checked.
+haskey(ENV, "COMPACTBASES_NO_PRECOMPILE") && __precompile__(false)
 
 import Base: eltype, axes, size, ==, getindex, checkbounds, copyto!, similar, show, step
 import Base.Broadcast: materialize