https://github.com/diamondlightsource/bookshelf-i18-xrf
A bookshelf repository for i18 xrf data processing
https://github.com/diamondlightsource/bookshelf-i18-xrf
analysis python xray-diffraction
Last synced: 25 days ago
JSON representation
A bookshelf repository for i18 xrf data processing
- Host: GitHub
- URL: https://github.com/diamondlightsource/bookshelf-i18-xrf
- Owner: DiamondLightSource
- License: apache-2.0
- Created: 2023-01-03T13:08:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T16:07:36.000Z (over 1 year ago)
- Last Synced: 2024-10-28T18:25:40.798Z (over 1 year ago)
- Topics: analysis, python, xray-diffraction
- Language: Jupyter Notebook
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# i18 xrf Notebook
This notebook is used to perform xrf processing of i18 data. This repo follows the bookshelf structure, meaning it will be automatically deployed in two varieties:
1. An interactive - jupyterlab - environment, for running both locally and hosted on the hosted JupyterLab instance
2. A headless processing image, for running both locally and as a cluster job
## Releasing a version
Simply "create a release" on github, this will run a set of continious integration (CI) jobs defined in `.github/workflows` to generate the nessacary containers.
To update the versions available via the diamond module system, run the Project General installation jenkins job for the "bookshelf" package;
This will query the GitHub API and catalogue all containers in the DiamondLightSource repository with the nessacary metadata.
## Running the Containers
### Interactive (local)
```
podman run --publish 8888:8888 ghcr.io/diamondlightsource/bookshelf-template/interactive:latest
```
or
```
module load bookshelf/bookshelf-i18-xrf/latest
bookshelf-i18-xrf-interactive
```
### Interactive (hosted)
1. Go to https://jupyterhub.diamond.ac.uk/hub/home
2. 'Start My Server' with `CONTAINER_IMAGE=ghcr.io/diamondlightsource/bookshelf-i18-xrf/interactive:latest`
### Processing
```
podman run --volume .:/outputs --volume .:/inputs --security-opt=label=type:container_runtime_t ghcr.io/diamondlightsource/bookshelf-template/processing:latest
```
or
```
module load bookshelf/bookshelf-i18-xrf/latest
bookshelf-i18-xrf-processing
```