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.

Sign up for GitHub

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 README.md #3

Merged
merged 1 commit into from
May 24, 2023
Merged

Update README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@

To have more information on what is available specifically through this kernel, type magic command `%help` in the interpreter.
# JupyterLab OpenScience Containers
This is the first sample container for which we demonstrate how to use some HPC tooling on Kubernetes or locally, using the https://cgs.jhuapl.edu codebase "MAGE" ( an ecosystem consisting of Fortran/Python MPI/OPENMP).
Here, we specifically use Paraview to plot Magneto-Hydro-Dynamics Data produced by MAGE, and thus we include the Python Packages required specifically for this HPC codebase (kaipy etc).
WIP: The Globus Endpoints for the data are public, but currently those datasets are rather large.

For a basic example of the kernel using Jupyter Notebook, see `ParaviewExample.ipynb`, for a sample Tutorial see `MagIonPlot.ipynb` , for opening a connection via Globus, see `globus_client_start.ipynb`.
In real life: there is a CI pipeline with the source code, that builds this Analysis-Container

For a basic example of the kernel using Jupyter Notebook, see `ParaviewExample.ipynb`, for a sample Tutorial see `MagIonPlot.ipynb` , for opening a connection via Globus, see `globus_client_start.ipynb`. To have more information on what is available specifically through this Jupyter-kernel, type magic command `%help` in the interpreter.

## TL;DR
```
Expand All @@ -10,10 +15,14 @@ docker run -it -p 8888:8888 ghcr.io/austriandatalab/aocc_openscience_mage:main

and you have the Jupyter-Lab-with-Paraview-Kernel running locally, accessible in your browser.

## For JupyterHub locally
You can also see our other repos for the full JupyterHub on Docker and Minikube (https://github.com/AustrianDataLAB/AOCC-JupyterHub-Trial)


## Test your own modified environment with docker locally

Included you find a `Dockerfile` with a simple test environment based on JupyterLab.

The installation is based on *Python 3.9* and uses *miniconda* to install Paraview 5.11.1 (on `conda-forge`).

If you wish to add your own modifications, clone this repo, modify it, then:
Expand All @@ -27,4 +36,7 @@ and to run it:
$ docker run -it -p 8888:8888 my_openscience_paraview:0.0.1
```
You will see the URL showing up to connect to the JupyterLab.
The container starts in the `./Examples` folder.

## For JupyterHub on Kubernetes
see our main project under:
(https://dev.azure.com/AOCC/OpenScienceLabs)