Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/anananacr/bblib_tutorial

Tutorial examples for bblib

https://github.com/anananacr/bblib_tutorial

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.7%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Tutorial examples for bblib

Basic Info
  • Host: GitHub
  • Owner: anananacr
  • License: gpl-3.0
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 21.7 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 2 years ago · Last pushed 10 months ago
Metadata Files
Readme License

README.md

bblib tutorial

This tutorial provides examples of how to use bblib centering methods.

This repository contains Jupyter notebooks and the data used in this tutorial.

In the folder bblib_tutorial/data you will find the data required to run the centering methods of bblib, as well as their corresponding masks in the bblib_tutorial/masks folder, and CrystFEL geometry files in the bblib_tutorial/geoms folder.

Remember to set the mask_file path in the geometry files (*.geom) to the corresponding path on your system.

This tutorial is runs on bblib version >= 3.1.0.

Installation

To run this tutorial, you will need Python 3.10.

  • In the terminal, type the following command: bash git clone https://github.com/anananacr/bblib_tutorial.git

  • Navigate into the bblib_tutorial folder:

bash cd bblib_tutorial

  • Install the requirements:

bash pip install -r requirements.txt

Usage

  • Start Jupyter Lab:

bash jupyter-lab

  • Go to the folder bblib_tutorial/bblib_tutorial and open the Jupyter notebook (*.ipynb) corresponding to the method you want to run.

  • Execute the cells, replacing /path/to/tutorial/ with the correct path on your system.

  • Geometry files and masks required to run the example data are included in the bblib_tutorial directory.

  • If plots_flag is set to True, plots of the intermediate steps will be saved in the /path/to/tutorial/center_refinement/plots folder.

Contact

Ana Carolina Rodrigues led the development of Beambusters from 2021 to 2025 at the Deutsches Elektronen-Synchrotron (DESY) in Hamburg, Germany.

For questions, please contact:

Email: sc.anarodrigues@gmail.com

Owner

  • Name: Ana Carolina Rodrigues
  • Login: anananacr
  • Kind: user
  • Location: Hamburg, Germany
  • Company: CFEL - DESY

PhD student in Physics.

GitHub Events

Total
  • Public event: 1
  • Push event: 4
Last Year
  • Public event: 1
  • Push event: 4

Dependencies

requirements.txt pypi
  • CacheControl ==0.14.0
  • Cython ==3.0.8
  • Jinja2 ==3.1.6
  • MarkupSafe ==3.0.2
  • PyYAML ==6.0.1
  • Pygments ==2.17.2
  • SecretStorage ==3.3.3
  • Send2Trash ==1.8.3
  • abstract ==2022.7.10
  • anyio ==4.10.0
  • appnope ==0.1.4
  • argon2-cffi ==25.1.0
  • argon2-cffi-bindings ==25.1.0
  • arrow ==1.3.0
  • asttokens ==3.0.0
  • async-lru ==2.0.5
  • attrs ==25.3.0
  • babel ==2.17.0
  • base32hex ==1.0.2
  • bblib ==2.2.0
  • beautifulsoup4 ==4.13.5
  • black ==24.1.1
  • bleach ==6.2.0
  • build ==1.0.3
  • certifi ==2024.2.2
  • cffi ==1.16.0
  • charset-normalizer ==3.3.2
  • cleo ==2.1.0
  • click ==8.1.7
  • colouration ==2020.7.26
  • comm ==0.2.3
  • contourpy ==1.2.0
  • crashtest ==0.4.1
  • cryptography ==42.0.5
  • cycler ==0.12.1
  • debugpy ==1.8.16
  • decorator ==5.2.1
  • defusedxml ==0.7.1
  • distlib ==0.3.8
  • dulwich ==0.21.7
  • exceptiongroup ==1.3.0
  • executing ==2.2.0
  • fabio ==2023.10.0
  • fastjsonschema ==2.19.1
  • filelock ==3.13.1
  • fonttools ==4.48.1
  • fqdn ==1.5.1
  • graphviz ==0.20.1
  • h11 ==0.16.0
  • h5py ==3.10.0
  • hdf5plugin ==4.4.0
  • httpcore ==1.0.9
  • httpx ==0.28.1
  • idna ==3.6
  • imageio ==2.33.1
  • importlib-metadata ==7.0.1
  • installer ==0.7.0
  • ipykernel ==6.30.1
  • ipympl ==0.9.7
  • ipython ==8.37.0
  • ipywidgets ==8.1.7
  • isoduration ==20.11.0
  • jaraco.classes ==3.3.1
  • jedi ==0.19.2
  • jeepney ==0.8.0
  • json5 ==0.12.1
  • jsonpointer ==3.0.0
  • jsonschema ==4.25.1
  • jsonschema-specifications ==2025.4.1
  • jupyter ==1.1.1
  • jupyter-console ==6.6.3
  • jupyter-events ==0.12.0
  • jupyter-lsp ==2.2.6
  • jupyter_client ==8.6.3
  • jupyter_core ==5.8.1
  • jupyter_server ==2.17.0
  • jupyter_server_terminals ==0.5.3
  • jupyterlab ==4.4.6
  • jupyterlab_pygments ==0.3.0
  • jupyterlab_server ==2.27.3
  • jupyterlab_widgets ==3.0.15
  • keyring ==24.3.0
  • kiwisolver ==1.4.5
  • lark ==1.2.2
  • lazy_loader ==0.3
  • llvmlite ==0.42.0
  • lxml ==5.1.0
  • markdown-it-py ==3.0.0
  • matplotlib ==3.8.2
  • matplotlib-inline ==0.1.7
  • mdurl ==0.1.2
  • mistune ==3.1.3
  • more-itertools ==10.2.0
  • msgpack ==1.1.1
  • msgpack-numpy ==0.4.8
  • mypy-extensions ==1.0.0
  • nbclient ==0.10.2
  • nbconvert ==7.16.6
  • nbformat ==5.10.4
  • nest-asyncio ==1.6.0
  • networkx ==3.2.1
  • notebook ==7.4.5
  • notebook_shim ==0.2.4
  • numpy ==1.26.4
  • ondamonitor ==23.8.3
  • overrides ==7.7.0
  • packaging ==23.2
  • pandas ==2.2.0
  • pandocfilters ==1.5.1
  • parso ==0.8.5
  • pathspec ==0.12.1
  • pexpect ==4.9.0
  • pillow ==10.2.0
  • pkginfo ==1.9.6
  • platformdirs ==4.2.0
  • poetry ==1.8.0
  • poetry-core ==1.9.0
  • poetry-plugin-export ==1.6.0
  • prometheus_client ==0.22.1
  • prompt_toolkit ==3.0.51
  • psutil ==7.0.0
  • ptyprocess ==0.7.0
  • pure_eval ==0.2.3
  • pycparser ==2.21
  • pyparsing ==3.1.1
  • pyproject_hooks ==1.0.0
  • python-dateutil ==2.8.2
  • python-json-logger ==3.3.0
  • pytz ==2024.1
  • pyzmq ==25.1.2
  • rapidfuzz ==3.6.1
  • referencing ==0.36.2
  • requests ==2.31.0
  • requests-toolbelt ==1.0.0
  • rfc3339-validator ==0.1.4
  • rfc3986-validator ==0.1.1
  • rfc3987-syntax ==1.1.0
  • rich ==13.7.0
  • rpds-py ==0.27.0
  • ruamel.yaml ==0.18.6
  • ruamel.yaml.clib ==0.2.8
  • scikit-image ==0.22.0
  • scipy ==1.12.0
  • shellingham ==1.5.4
  • six ==1.16.0
  • sniffio ==1.3.1
  • soupsieve ==2.7
  • stack-data ==0.6.3
  • terminado ==0.18.1
  • tifffile ==2024.2.12
  • tinycss2 ==1.4.0
  • tomli ==2.0.1
  • tomlkit ==0.12.3
  • tornado ==6.5.2
  • traitlets ==5.14.3
  • trove-classifiers ==2024.2.23
  • types-python-dateutil ==2.9.0.20250822
  • typing_extensions ==4.10.0
  • tzdata ==2024.1
  • uri-template ==1.3.0
  • urllib3 ==2.2.1
  • virtualenv ==20.25.1
  • wcwidth ==0.2.13
  • webcolors ==24.11.1
  • webencodings ==0.5.1
  • websocket-client ==1.8.0
  • widgetsnbextension ==4.0.14
  • xattr ==1.2.0
  • zipp ==3.17.0