WIP: replace REQUIRE by Project.toml

carstenbauer commented 4 years ago

Drop the old REQUIRE file in favor of the new Project.toml. This way the repository (up to a Manifest.toml) forms a Julia project and can easily be ] instantiated.

I also adjusted the makefile such that julia is started with --project, i.e. in the local environment.

Remaining question: should we also specify compatibilities through [compat] entries?

Closes #23.

carstenbauer commented 4 years ago

Turns out that we also have to tell the julia/juliacon blocks (pythontex) to start julia with --project. How do we do that?

tawheeler commented 4 years ago

We solve this problem by having pull_julia_code.jl export to a Julia package instead, and we import that package. That package has its own requirements .toml that allows us to manage dependency installation.

I don't know how to change the pythontex startup command. Likely a change to pythontex itself.

johnnychen94 commented 4 years ago

If you're going to work on this, can you also update the Gitlab CI template accordingly?

https://github.com/sisl/tufte_algorithms_book/blob/9bfae987a50ff7570b643c7b347a9b689d05c943/.gitlab-ci.yml#L26

carstenbauer commented 4 years ago

If you're going to work on this, can you also update the Gitlab CI template accordingly?

Done. I also updated the README accordingly. There is no need to use jlpkg anymore.

We solve this problem by having pull_julia_code.jl export to a Julia package instead, and we import that package. That package has its own requirements .toml that allows us to manage dependency installation.

I'm not sure I understand this fully. Even if you make pull_julia_code.jl export to a package (this part isn't in the repo is it?), what do you mean by "import it"? Wouldn't you still have to add this package to the global env for pythontex to find it? After all, it's the purpose of this PR to make the repo a self-contained Julia project such that no packages have to be added to the global (v1.x) environment.

carstenbauer commented 4 years ago

Note to future self:

Apparently only the juliaconsole blocks aren't executed in the local env. The juliacode blocks seem to work fine. However I haven't really understood why ...

Trying to investigate this I found https://github.com/gpoore/pythontex/blob/master/pythontex/pythontex_engines.py. Here, both julia and juliacon CodeEngines are being defined. Note that juliacon doesn't seem to include the julia template nor the "julia wrapper".

tawheeler commented 4 years ago

Even if you make pull_julia_code.jl export to a package (this part isn't in the repo is it?), what do you mean by "import it"? Wouldn't you still have to add this package to the global env for pythontex to find it?

Basically, we have a Julia package that loads all_algorithm_blocks.jl. That part is not in the repo. We run using OurPackage within a pythontex call at the top of book.tex. Said package has its own github repo and .toml such that we can update its dependencies.

\begin{jlcode}
    using OurPackage
\end{jlcode}

We actually moved the code to its own repo to benefit from precompilation. We were running into huge load times. Our new book has more, and heftier, code than the first textbook. The sacrifice we made is that now there are two repos - one for the book and one for the Julia code associated with the book. The latter is only updated when we add new code utilities or code dependencies.

After all, it's the purpose of this PR to make the repo a self-contained Julia project such that no packages have to be added to the global (v1.x) environment.

The package-export approach does store all dependencies in one place. At the same time, we are not running ] instantiate as you would with this standalone-approach. This PR may very well be the way to go.

BeastyBlacksmith commented 4 years ago

Turns out that we also have to tell the julia/juliacon blocks (pythontex) to start julia with --project. How do we do that?

You can second my PR here

BeastyBlacksmith commented 4 years ago

It got merged 🎉

tawheeler commented 3 years ago

Is this PR good to go?