Skip to content

Commit b2296cf

Browse files
committed
created environment file, and added installation instructions to contributing.
1 parent 522ccf2 commit b2296cf

File tree

2 files changed

+52
-4
lines changed

2 files changed

+52
-4
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ and submitting [bug reports][issues]
7171
about things that don't work, aren't clear, or are missing.
7272
If you are looking for ideas, please see the 'Issues' tab for
7373
a list of issues associated with this repository,
74-
or you may also look at the issues for [Data Carpentry][dc-issues],
74+
or you may also look at the issues for [Data Carpentry][dc-issues],
7575
[Software Carpentry][swc-issues], and [Library Carpentry][lc-issues] projects.
7676

7777
Comments on issues and reviews of pull requests are just as welcome:
@@ -130,17 +130,30 @@ Extensive instructions for building and viewing the pages locally can be found [
130130
```bash
131131
# apt (Ubuntu/Devian)
132132
sudo apt install ruby-dev ruby-bundler
133+
```
134+
or
135+
```bash
133136
# dnf (Fedora/Redhat)
134137
sudo dnf install rubygem-bundler ruby-devel
135-
to install the required ruby packages and
138+
```
139+
140+
Alternatively, there's an environment file available which can be installed in conda with:
141+
```bash
142+
conda env create -f environment.yml -n esmvaltool_tutorial
143+
```
144+
145+
To install the required ruby packages, run the following command in the tutorial's
146+
main directory to build and serve the website locally.:
136147
```bash
137148
make serve
138149
```
139-
to build and serve the website locally. The output on the terminal will contain a line similar to
150+
151+
The output on the terminal will contain a line similar to:
140152
```
141153
Server address: http://127.0.0.1:4000
142154
```
143-
open the address in your browser to preview the website.
155+
This address can be opened in your browser to preview the website.
156+
144157

145158
## Other Resources
146159

environment.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: tutorial
2+
channels:
3+
- conda-forge
4+
- defaults
5+
dependencies:
6+
- _libgcc_mutex=0.1=conda_forge
7+
- _openmp_mutex=4.5=0_gnu
8+
- binutils_impl_linux-64=2.33.1=h53a641e_8
9+
- binutils_linux-64=2.33.1=h9595d00_17
10+
- ca-certificates=2019.11.28=hecc5488_0
11+
- gcc_impl_linux-64=7.3.0=hd420e75_5
12+
- gcc_linux-64=7.3.0=h553295d_17
13+
- gdbm=1.18=h0a1914f_1
14+
- gmp=6.2.0=he1b5a44_2
15+
- gxx_impl_linux-64=7.3.0=hdf63c60_5
16+
- gxx_linux-64=7.3.0=h553295d_17
17+
- icu=64.2=he1b5a44_1
18+
- ld_impl_linux-64=2.33.1=h53a641e_8
19+
- libffi=3.2.1=he1b5a44_1006
20+
- libgcc-ng=9.2.0=h24d8f2e_2
21+
- libgomp=9.2.0=h24d8f2e_2
22+
- libiconv=1.15=h516909a_1005
23+
- libstdcxx-ng=9.2.0=hdf63c60_2
24+
- libxml2=2.9.10=hee79883_0
25+
- libxslt=1.1.33=h31b3aaa_0
26+
- ncurses=6.1=hf484d3e_1002
27+
- openssl=1.1.1d=h516909a_0
28+
- rb-mini_portile2=2.4.0=hc42de5b_0
29+
- rb-nokogiri=1.10.8=he0b3888_0
30+
- readline=8.0=hf8c457e_0
31+
- ruby=2.6.5=h305c5c1_0
32+
- xz=5.2.4=h14c3975_1001
33+
- yaml=0.1.7=h14c3975_1001
34+
- zlib=1.2.11=h516909a_1006
35+

0 commit comments

Comments
 (0)