Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Ubuntu install instructions for 2020 fall #56

Merged
merged 21 commits into from
Jul 29, 2020

Conversation

joelostblom
Copy link

I am making this a draft because I am adding a few comments to the changes, will ping when ready for review.

resources_pages/install_ds_stack_ubuntu.md Show resolved Hide resolved
resources_pages/install_ds_stack_ubuntu.md Show resolved Hide resolved
resources_pages/install_ds_stack_ubuntu.md Outdated Show resolved Hide resolved
resources_pages/install_ds_stack_ubuntu.md Show resolved Hide resolved
resources_pages/install_ds_stack_ubuntu.md Show resolved Hide resolved
resources_pages/install_ds_stack_ubuntu.md Show resolved Hide resolved
resources_pages/install_ds_stack_ubuntu.md Outdated Show resolved Hide resolved
resources_pages/install_ds_stack_ubuntu.md Show resolved Hide resolved

```
install.packages('tinytex')
tinytex::install_tinytex()
```

The above is all we need to have LaTeX work with R Markdown documents, however to for Jupyter we need to add the TinyTex executables to our `PATH` and install several more packages.
The above is all we need to have LaTeX work with R Markdown documents, however to for Jupyter we need to add the TinyTex executables to our `PATH` and install several more packages.

To add the TinyTex executables to our `PATH` we need to edit our `.bashrc` file. The TinyTex executables are usually installed in `$HOME/bin`. Thus, add the lines below to the bottom of your `.bashrc` file (which you can open by `code $HOME/.bashrc`):

```
# add TinyTex executables to the path
export PATH="$HOME/bin:$PATH"
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it safe to prepend this directory or should we append it instead? I don't know what is higher risk, unwanted executables in this dir that get unwanted preference over other system packages, or unintentional addition of latex packages to other path dirs that get preference over tinyTex unless it is first.

Copy link

@ttimbers ttimbers Jul 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, change it to append instead (assuming it still works, which it should). I wondered that as I was doing it...

Also, can you confirm that after these LaTeX install instructions you can create PDFs from Jupyter? I see you do this later.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup works fine, updated the instructions. I also added this brief explanation of what PATH is (maybe slightly technically inprecise but helpful at this point):

(PATH is a collection of directories which contain the available executable programs on your computer).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

@joelostblom joelostblom marked this pull request as ready for review July 24, 2020 19:02
@joelostblom
Copy link
Author

joelostblom commented Jul 24, 2020

@ttimbers Ready for review! I have gone through everything except Chrome and LastPass instructions. Also it seems like I can't assign people to review, I might need different permissions on this repo. (my bad, I had not accepted your invite to the team)

@joelostblom joelostblom self-assigned this Jul 24, 2020
@joelostblom joelostblom removed their assignment Jul 24, 2020
@joelostblom
Copy link
Author

Just confirmed that chrome and lastpass instructions are correct.

Copy link

@ttimbers ttimbers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There were a few other comments I made before officially starting this review (sorry), so please read through all my comments that I posted tonight in addition to these. Then ping me when done and I will accept the PR.

resources_pages/install_ds_stack_ubuntu.md Outdated Show resolved Hide resolved
We will be using several Jupyter extensions that help us use Juypter notebooks more smoothly with Git & GitHub. To install them, paste the following in the terminal below:
## JupyterLab extensions

We will be using a couple of JupyterLab git extensions to facilitate using Jupyter notebooks with Git & GitHub. Install them via the following commands:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are not all git extensions technically. Jupytext is kind of like nbconvert on steriods. So I would prefer to not refer to all of these as git extensions.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, updated.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks!


```
install.packages(c('tidyverse', 'tinytex', 'blogdown', 'xaringan', 'renv'))
install.packages(c('tidyverse', 'tinytex', 'blogdown', 'xaringan', 'renv', 'IRkernel'))

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove tinytex here and just install it later under the LaTeX section, as I think this logically makes more sense (as they need another command to install it as well).

Suggested change
install.packages(c('tidyverse', 'tinytex', 'blogdown', 'xaringan', 'renv', 'IRkernel'))
install.packages(c('tidyverse', 'blogdown', 'xaringan', 'renv', 'IRkernel'))

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, do you want me to also move back IRkernel to it's own section? I thought it would be nice to just have to run install.packages once, but I also see the value in having each heading being largely self-contained.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah maybe... I think conceptually it makes sense so folks know what the individual things are for (tinyTex for LaTeX, IRkernel for the R kernel for Jupyter, and the rest are R packages for other stuff).

Missed this in the previous commit
- Update Github link
- Indicate that jupytext is not a jupyterlab extension
- Clarify R version numbers
- Note how RStudio updates
- Remove duplicate install of tiny tex
- Append instead of repend to path
Copy link
Author

@joelostblom joelostblom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ttimbers Thanks for the review, see my replies here!

resources_pages/install_ds_stack_ubuntu.md Show resolved Hide resolved
resources_pages/install_ds_stack_ubuntu.md Show resolved Hide resolved
resources_pages/install_ds_stack_ubuntu.md Show resolved Hide resolved
resources_pages/install_ds_stack_ubuntu.md Outdated Show resolved Hide resolved
We will be using several Jupyter extensions that help us use Juypter notebooks more smoothly with Git & GitHub. To install them, paste the following in the terminal below:
## JupyterLab extensions

We will be using a couple of JupyterLab git extensions to facilitate using Jupyter notebooks with Git & GitHub. Install them via the following commands:
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, updated.

resources_pages/install_ds_stack_ubuntu.md Outdated Show resolved Hide resolved

```
install.packages(c('tidyverse', 'tinytex', 'blogdown', 'xaringan', 'renv'))
install.packages(c('tidyverse', 'tinytex', 'blogdown', 'xaringan', 'renv', 'IRkernel'))
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, do you want me to also move back IRkernel to it's own section? I thought it would be nice to just have to run install.packages once, but I also see the value in having each heading being largely self-contained.


```
install.packages('tinytex')
tinytex::install_tinytex()
```

The above is all we need to have LaTeX work with R Markdown documents, however to for Jupyter we need to add the TinyTex executables to our `PATH` and install several more packages.
The above is all we need to have LaTeX work with R Markdown documents, however to for Jupyter we need to add the TinyTex executables to our `PATH` and install several more packages.

To add the TinyTex executables to our `PATH` we need to edit our `.bashrc` file. The TinyTex executables are usually installed in `$HOME/bin`. Thus, add the lines below to the bottom of your `.bashrc` file (which you can open by `code $HOME/.bashrc`):

```
# add TinyTex executables to the path
export PATH="$HOME/bin:$PATH"
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup works fine, updated the instructions. I also added this brief explanation of what PATH is (maybe slightly technically inprecise but helpful at this point):

(PATH is a collection of directories which contain the available executable programs on your computer).

resources_pages/install_ds_stack_ubuntu.md Outdated Show resolved Hide resolved
resources_pages/install_ds_stack_ubuntu.md Show resolved Hide resolved
@ttimbers
Copy link

@joelostblom - I have just gone through your review response and made a few more comments. Once you go through these and address them, ping me and I'll call this done and merge it.

Copy link
Author

@joelostblom joelostblom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be good to merge now @ttimbers. I will attend your office hours tomorrow also in case we need to discuss something about this quickly before merging.

resources_pages/install_ds_stack_ubuntu.md Show resolved Hide resolved
resources_pages/install_ds_stack_ubuntu.md Show resolved Hide resolved
resources_pages/install_ds_stack_ubuntu.md Outdated Show resolved Hide resolved
@ttimbers
Copy link

@joelostblom - I think the one thing left to do is to pull out the IRkernel package install as discussed above (conceptually this makes more sense even though its a bit more work).

@joelostblom
Copy link
Author

@ttimbers I did do this in 7aaba85, or are we referring to different things?

@ttimbers
Copy link

Sorry, that is perfect, I must have clicked on a different commit and saw that it wasn't done. Apologies! Looks good and I will merge now!

@ttimbers ttimbers merged commit cdaf793 into UBC-MDS:master Jul 29, 2020
@joelostblom
Copy link
Author

Great! I will start with the win instructions tomorrow, making similar changes as what we agreed upon here.

@ttimbers
Copy link

Before you move onto that - can you bring the relevant changes we made to ubuntu back to mac?

@joelostblom
Copy link
Author

Yes, sorry forgot that we said that when I wrote above, I'll do that first tomorrow morning.

@joelostblom joelostblom mentioned this pull request Jul 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants