Skip to content

Commit b0af7a5

Browse files
committed
update.jl in scripts/, and update already out of date readme
1 parent 7f38287 commit b0af7a5

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

ReadMe.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,13 @@ Directories:
1515
- [`pkg/`](pkg) contains Julia packages, which define functions and data types that are reused in multiple notebooks.
1616
- [`web/`](web) contains config and code to build the [website](https://tfiers.github.io/phd)
1717
where the notebooks are hosted (using [JupyterBook](https://jupyterbook.org/)).
18+
- [`scripts/`](scripts) contains scripts for updating dependencies and speeding up their imports.
19+
1820

1921
Files:
2022
- [`Project.toml`](Project.toml) lists the identifiers of the Julia packages our code directly depends on.
2123
- `Manifest.toml` records the exact versions of all packages used to generate the results (i.e. the notebook outputs).
22-
- `setup.jl` is used to generate a new `Manifest.toml`, both for the main project and for the packages in `pkg/`.
24+
- `update.jl` is used to generate a new `Manifest.toml`, both for the main project and for the packages in `pkg/`.
2325
It is only to be used when working on this codebase; not when you want to reproduce the results.
2426

2527

@@ -71,7 +73,7 @@ To reproduce results, *i.e.* to succesfully run one of the notebooks:
7173
which is included in the repository for the purpose of reproducibility.
7274
- Downloading and installing all these packages will take a while.
7375
- If you want to instead use newer versions of dependencies (maybe because you
74-
already have them downloaded), run `julia setup.jl` in the terminal,
76+
already have them downloaded), run `julia scripts/update.jl` in the terminal,
7577
instead of `instantiate`.
7678
</details>
7779

File renamed without changes.

0 commit comments

Comments
 (0)