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

Add biocworkshop to howto #10

Merged
merged 2 commits into from
Jul 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions .github/workflows/publish-docker.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish Docker image
name: Publish Docker Image

on:
push:
Expand All @@ -20,16 +20,16 @@ jobs:
registry: ghcr.io
dockerfile: Dockerfile.pythononly

publish_docker_bioc:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Publish to Registry
uses: elgohr/Publish-Docker-Github-Action@v5
with:
name: ${{ github.repository }}/bioc:${{ github.ref_name }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
registry: ghcr.io
dockerfile: Dockerfile.bioc
# publish_docker_bioc:
# runs-on: ubuntu-latest
# steps:
# - name: Checkout
# uses: actions/checkout@v3
# - name: Publish to Registry
# uses: elgohr/Publish-Docker-Github-Action@v5
# with:
# name: ${{ github.repository }}/bioc:${{ github.ref_name }}
# username: ${{ github.actor }}
# password: ${{ secrets.GITHUB_TOKEN }}
# registry: ghcr.io
# dockerfile: Dockerfile.bioc
Binary file added assets/biocworkshop_jupyter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/biocworkshop_open_session.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/biocworkshop_run_tool.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/biocworkshop_select_rjupyter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 38 additions & 13 deletions howto.qmd
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
# How to run the notebooks

## Option 1: Run notebooks locally
## Option 1. Using BiocWorkshop (Preferred)

If you want to run locally, please clone the repository and install the python packages used for the workshop.
If you are attending the workshop at Bioconductor:

```sh
git clone https://github.com/BiocPy/BiocWorkshop2024
cd BiocWorkshop2024
1. Open [BiocWorkshops](https://workshop.bioconductor.org/) in a new tab.
2. Select "R/Bioconductor Jupyter Workshop" as shown in the screenshot.

# Assuming python is available
# You are free to use mamba, conda or virtualenv's
pip install -r requirements.txt
![](./assets/biocworkshop_select_rjupyter.png)

# Start the jupyter server
jupyter lab
```
3. Click the "Run the tool".

![](./assets/biocworkshop_run_tool.png)

4. Click on "Interactive Tools" in the left sidebar to check on the status of the session. Once the session is ready, click on the "BiocPy" to open the Jupyter notebook.

Then checkout the [notebook](https://github.com/BiocPy/BiocWorkshop2024/tree/master/notebook) directory that contain Jupyter notebooks.
![](./assets/biocworkshop_open_session.png)

5. You should be able to see the BiocWorkshop repository cloned into the session.

![](./assets/biocworkshop_jupyter.png)

----

## Option 2: Using Google Colab

Expand All @@ -35,4 +40,24 @@ To open the session in Google Colab:

:::{.callout-important}
This process does not download the [RDS file](https://github.com/BiocPy/BiocWorkshop2024/tree/master/notebook) available in the repository. Folks might have to manually download this to their Google Colab sessions.
:::
:::

----

## Option 3: Run notebooks locally

If you want to run locally, please clone the repository and install the python packages used for the workshop.

```sh
git clone https://github.com/BiocPy/BiocWorkshop2024
cd BiocWorkshop2024

# Assuming python is available
# You are free to use mamba, conda or virtualenv's
pip install -r requirements.txt

# Start the jupyter server
jupyter lab
```

Then checkout the [notebook](https://github.com/BiocPy/BiocWorkshop2024/tree/master/notebook) directory that contain Jupyter notebooks.