You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/10-users/60-sessions/guides/00-environments/20-create-environment-with-custom-packages-installed.md
+47-19Lines changed: 47 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,11 @@
1
1
# Create an environment with custom packages installed
2
2
3
-
If you’d like a set of custom packages to be installed and ready to go when you (or anyone else) launches a session in your project, you can take advantage of Renku’s **code based environments**.
3
+
If you’d like a set of custom packages to be installed and ready to go when you (or anyone else)
4
+
launches a session in your project, you can take advantage of Renku’s **code based environments**.
4
5
5
-
With Renku code based environments, you can point Renku to a code repository that contains an environment definition file, such as a `environment.yml`, `requirements.txt`, or `pyproject.toml`, and Renku will build a custom environment for your session for you!
6
+
With Renku code based environments, you can point Renku to a code repository that contains an
7
+
environment definition file, such as an `environment.yml`, `requirements.txt`, `pyproject.toml`, or
8
+
`renv.lock`, and Renku will build a custom environment for your session for you!
6
9
7
10
This guide has 2 parts:
8
11
@@ -13,15 +16,7 @@ This guide has 2 parts:
13
16
14
17
## What kinds of environment definitions are supported?
15
18
16
-
RenkuLab’s code-based environments currently supports creating **Python** environments. Support for more languages is coming soon!
17
-
18
-
:::tip
19
-
20
-
Are you working in R? Support for R is coming soon. For now, for working with R please see
5. Select the **Environment****type** (Python, _more coming soon_)
188
-
6. Select the **User interface** you’d like your session to have (VSCodium or Jupyterlab, _more coming soon_).
211
+
5. Select the **Environment type**. Choose **Python** for Python environment definition files,
212
+
or **R** for repositories that use `renv.lock`.
213
+
6. Select the **User interface** you’d like your session to have, such as VSCodium/JupyterLab
214
+
for Python environments or RStudio for R environments.
189
215
7. Click **Next**
190
216
8. Define the **name** of the Session Launcher
191
217
9. Select the default **compute resources**
@@ -199,7 +225,9 @@ When the environment is built, you can launch your session.
199
225
200
226
## Updating a code-based environment
201
227
202
-
1. When you want to make changes to your environment (add new packages), first update the environment definition file in the code repository where the environment is defined.
228
+
1. When you want to make changes to your environment (add new packages), first
229
+
update the environment definition file in the code repository where the
230
+
environment is defined.
203
231
2. Then, rebuild the environment in RenkuLab:
204
232
1. Click on the session launcher to open the session launcher side panel.
205
233
2. Navigate to the **Session Environment** section.
Copy file name to clipboardExpand all lines: docs/docs/10-users/60-sessions/guides/00-environments/25-create-environment-with-custom-packages-private-code-repository.md
+17-5Lines changed: 17 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,22 @@
1
1
# Create an environment with custom packages from a private code repository (GitHub Actions)
2
2
3
-
Would you like Renku to create an environment for you with the packages you need pre-installed? Renku can create a docker image for your Renku session for you based on a environment definition file in a code repository, such as a `environment.yml`, `requirements.txt`, or `pyproject.toml`.
3
+
Would you like Renku to create an environment for you with the packages you need pre-installed?
4
+
Renku can create a docker image for your Renku session for you based on an environment definition
5
+
file in a code repository, such as an `environment.yml`, `requirements.txt`, `pyproject.toml`, or
6
+
`renv.lock`.
4
7
5
-
If your code repository is public, you can have Renku build this image directly as part of your project! See [How to create an environment with custom packages installed](create-environment-with-custom-packages-installed).
8
+
If your code repository is public, you can have Renku build this image directly as part of your
9
+
project! See [How to create an environment with custom packages
If your code repository is private, follow the instructions below.
12
+
The instructions below are for _private_ code repositories that cannot use the
13
+
automatic builds in RenkuLab.
8
14
9
15
## Create a GitHub action to build a docker image
10
16
11
-
1. First, make sure your code repository meets the requirements for Renku to build an image for you. See [What kinds of environment definitions are supported?](create-environment-with-custom-packages-installed)
17
+
1. First, make sure your code repository meets the requirements for Renku to build an image for you.
2. In your GitHub code repository, in the upper menu, click on **Actions**.
13
21
14
22
<pclass="image-container-l">
@@ -69,10 +77,14 @@ If your code repository is private, follow the instructions below.
69
77
frontend: jupyterlab
70
78
```
71
79
72
-
6. By default, the action defined above will create an image with JupyterLab as the front end. If you prefer a different front end, replace `jupyterlab` in the last line of the file with one of the following alternative front ends:
80
+
6. By default, the action defined above will create an image with JupyterLab as
81
+
the front end. If you prefer a different front end, replace `jupyterlab` in
82
+
the last line of the file with one of the following alternative front ends:
73
83
- `jupyterlab`: Web-based interactive development for Jupyter notebooks, code, and data.
74
84
- `vscodium`: A freely-licensed version of Microsoft’s editor VS Code.
75
85
- `ttyd`: A web-based terminal with a minimalist interface.
0 commit comments