This repository provides various notebooks for users of the neutron imaging beamlines at ORNL. Full tutorial of most of the notebooks can be found at here.
This project uses Pixi for environment and dependency management. Install Pixi:
curl -fsSL https://pixi.sh/install.sh | bash- Clone the repository:
git clone https://github.com/ornlneutronimaging/python_notebooks.git
cd python_notebooks_development- Install dependencies:
pixi install- Launch Jupyter Lab:
pixi run labpixi run lab- Start Jupyter Labpixi run notebook- Start Jupyter Notebookpixi run test- Run testspixi run test_imports- Verify all packages import correctlypixi run test_all- Run all testspixi run check- Run installation check
For development:
pixi run -e dev lint- Run code linting
To learn more about the notebooks and how to use them, refer to the complete tutorial found on our imaging web site https://neutronimaging.pages.ornl.gov
For more information about the facility and instruments, navigate to the following links:
- ORNL Neutron Imaging Website
- Multimodal Advanced Radiography Station (MARS)
- Versatile Neutron Imaging Instrument (VENUS)
You can contribute back to this repo by
- fork it to your own account
- make the necessary adjustments
- make a pull request on Github.
The maintainer of this repo will review your changes and provided feedback if needed. A more detailed instructions can be found in this post by DataSchool.
To run the tests:
pixi run test
# or
pixi run test_all # runs all test suitesThis project uses Pixi for reproducible environments. The pixi.lock file ensures consistent dependencies across all installations.
- Default environment:
pixi shellorpixi run <command> - Development environment:
pixi run -e dev <command>
Notebooks are distributed directly by the Computational Instrument Scientist.