Skip to content

Commit c8fde53

Browse files
authored
Make package install instructions bigger in tutorials (#82)
Make package install instructions bigger in curve-fit.md, tabular-data.md, jwst-image-scale-bar.md.
1 parent bd68e7d commit c8fde53

File tree

3 files changed

+29
-8
lines changed

3 files changed

+29
-8
lines changed

docs/src/tutorials/curve-fit.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,14 @@ This tutorial will demonstrate fitting data with a straight line (linear regress
1111
* [`Turing`](https://turing.ml/stable/): we'll use this package for Bayesian modelling.
1212
* [`PairPlots`](https://github.com/sefffal/PairPlots.jl): we'll use this for creating a corner plot of the posterior from our Bayesian models.
1313

14-
You can install the necessary packages by running Julia, and typing `]` to enter Pkg-mode. Then: `add Plots Optimization OptimizationOptimJL Turing PairPlots`.
15-
Alternatively, you can run `using Pkg; Pkg.add(["Plots", "Optimization", "OptimizationOptimJL", "Turing", "PairPlots"])`.
14+
You can install the necessary packages by running Julia, and typing `]` to enter Pkg-mode. Then:
15+
```julia-repl
16+
pkg> add Plots Optimization OptimizationOptimJL Turing PairPlots
17+
```
18+
Alternatively, you can run
19+
```julia
20+
using Pkg; Pkg.add(["Plots", "Optimization", "OptimizationOptimJL", "Turing", "PairPlots"])
21+
```
1622
In your own code, you most likely won't need all of these packages. Pick and choose the one that best fits your problem.
1723

1824
If you will be using these tools as part of a bigger project, it's strongly recommended to create a [Julia Project](https://pkgdocs.julialang.org/v1/environments/) to record package versions. If you're just experimenting, you can create a temporary project by running `] activate --temp`.

docs/src/tutorials/jwst-image-scale-bar.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,19 @@ Let's get started!
99
* [`AstroImages`](http://juliaastro.org/AstroImages/stable/): we'll use this package to load and display the image
1010
* [`Plots`](https://docs.juliaplots.org/stable/): we'll use this package to display coordinates along the image and add the scalebar
1111

12-
You can install the necessary packages by running Julia, and typing `]` to enter Pkg-mode. Then: `add AstroImages Plots`.
13-
Alternatively, you can run `using Pkg; Pkg.add(["AstroImages", "Plots"])`.
12+
You can install the necessary packages by running Julia, and typing `]` to enter Pkg-mode. Then:
13+
```julia-repl
14+
pkg> add AstroImages Plots
15+
```
16+
Alternatively, you can run
17+
```julia
18+
using Pkg; Pkg.add(["AstroImages", "Plots"])
19+
```
1420

15-
If you will be using these tools as part of a bigger project, it's strongly recommended to create a [Julia Project](https://pkgdocs.julialang.org/v1/environments/) to record package versions. If you're just experimenting, you can create a temporary project by running `] activate --temp`.
21+
If you will be using these tools as part of a bigger project, it's strongly recommended to create a [Julia Project](https://pkgdocs.julialang.org/v1/environments/) to record package versions. If you're just experimenting, you can create a temporary project by running
22+
```julia-repl
23+
pkg> activate --temp
24+
```
1625

1726
If you're using [Pluto notebooks](https://github.com/fonsp/Pluto.jl), installing and recording package versions in a project are handled for you automatically.
1827

docs/src/tutorials/tabular-data.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Tables are a common way to represent various forms of catalogs. One common format for storing this data in astronomy is as a FITS file.
44

5-
In these examples, we will fetch and load the Hipparcos-GAIA Catalog of Accelerations [(HGCA, Brandt et al 2021])](https://iopscience.iop.org/article/10.3847/1538-4365/abf93c).
5+
In these examples, we will fetch and load the Hipparcos-GAIA Catalog of Accelerations [(HGCA, Brandt et al 2021)](https://iopscience.iop.org/article/10.3847/1538-4365/abf93c).
66
This catalog cross matches stars from the Hipparcos and GAIA catalogs in order to calculate the long term astrometric proper motion anomaly; that is, the star's deviation from straight line motion in the plane of the sky over the ~20 baseline between the two missions.
77

88
A wide range of tabular data formats are supported in Julia under a common [Tables.jl interface](https://tables.juliadata.org). For example,
@@ -16,8 +16,14 @@ A wide range of tabular data formats are supported in Julia under a common [Tabl
1616
* [`Plots`](https://docs.juliaplots.org/stable/): we'll use this package to visualize the contents of the table
1717
* [`AstroLib`](https://juliaastro.org/AstroLib/stable/): general utility package. We'll use a helper function to compute a map projection.
1818

19-
You can install the necessary packages by running Julia, and typing `]` to enter Pkg-mode. Then: `add FITSIO DataFrames Plots AstroLib`.
20-
Alternatively, you can run `using Pkg; Pkg.add(["FITSIO", "DataFrames", "Plots", "AstroLib"])`.
19+
You can install the necessary packages by running Julia, and typing `]` to enter Pkg-mode. Then:
20+
```julia-repl
21+
pkg> add FITSIO DataFrames Plots AstroLib
22+
```
23+
Alternatively, you can run
24+
```julia
25+
using Pkg; Pkg.add(["FITSIO", "DataFrames", "Plots", "AstroLib"])
26+
```
2127

2228
If you will be using these tools as part of a larger project, it's strongly recommended to create a [Julia Project](https://pkgdocs.julialang.org/v1/environments/) to record package versions. If you're just experimenting, you can create a temporary project by running `] activate --temp`.
2329

0 commit comments

Comments
 (0)