{"id":25895517,"url":"https://github.com/diamondlightsource/bookshelf-i18-xrf","last_synced_at":"2026-05-05T16:39:11.557Z","repository":{"id":141255064,"uuid":"584764535","full_name":"DiamondLightSource/bookshelf-i18-xrf","owner":"DiamondLightSource","description":"A bookshelf repository for i18 xrf data processing","archived":false,"fork":false,"pushed_at":"2024-10-28T16:07:36.000Z","size":27,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-28T18:25:40.798Z","etag":null,"topics":["analysis","python","xray-diffraction"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DiamondLightSource.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-03T13:08:09.000Z","updated_at":"2024-10-28T16:07:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"08ff8c21-bfb8-445c-a249-38373687fa8d","html_url":"https://github.com/DiamondLightSource/bookshelf-i18-xrf","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":"DiamondLightSource/bookshelf-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiamondLightSource%2Fbookshelf-i18-xrf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiamondLightSource%2Fbookshelf-i18-xrf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiamondLightSource%2Fbookshelf-i18-xrf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiamondLightSource%2Fbookshelf-i18-xrf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DiamondLightSource","download_url":"https://codeload.github.com/DiamondLightSource/bookshelf-i18-xrf/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241582515,"owners_count":19985845,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analysis","python","xray-diffraction"],"created_at":"2025-03-02T22:31:43.392Z","updated_at":"2026-05-05T16:39:11.518Z","avatar_url":"https://github.com/DiamondLightSource.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# i18 xrf Notebook\n\nThis 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:\n\n1. An interactive - jupyterlab - environment, for running both locally and hosted on the hosted JupyterLab instance\n2. A headless processing image, for running both locally and as a cluster job\n\n## Releasing a version\n\nSimply \"create a release\" on github, this will run a set of continious integration (CI) jobs defined in `.github/workflows` to generate the nessacary containers.\n\nTo update the versions available via the diamond module system, run the Project General installation jenkins job for the \"bookshelf\" package;\nThis will query the GitHub API and catalogue all containers in the DiamondLightSource repository with the nessacary metadata.\n\n## Running the Containers\n\n### Interactive (local)\n\n```\npodman run --publish 8888:8888 ghcr.io/diamondlightsource/bookshelf-template/interactive:latest\n```\nor\n```\nmodule load bookshelf/bookshelf-i18-xrf/latest\nbookshelf-i18-xrf-interactive\n```\n\n### Interactive (hosted)\n\n1.  Go to https://jupyterhub.diamond.ac.uk/hub/home\n2.  'Start My Server' with `CONTAINER_IMAGE=ghcr.io/diamondlightsource/bookshelf-i18-xrf/interactive:latest`\n\n### Processing\n\n```\npodman run --volume .:/outputs --volume .:/inputs --security-opt=label=type:container_runtime_t ghcr.io/diamondlightsource/bookshelf-template/processing:latest\n```\nor\n```\nmodule load bookshelf/bookshelf-i18-xrf/latest\nbookshelf-i18-xrf-processing\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiamondlightsource%2Fbookshelf-i18-xrf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdiamondlightsource%2Fbookshelf-i18-xrf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiamondlightsource%2Fbookshelf-i18-xrf/lists"}