Giter VIP home page Giter VIP logo

i16sim's Introduction

i16sim readme

Simulation package for the I16 6-circle kappa diffractometer at Diamond Light Source Ltd.

Implements diffcalc functionality in Blender and uses it to animate a model of the diffractometer.

Authors:Aurys Silinga, Dan Porter
Beamline:I16
Facility:Diamond Light Source Ltd
Version:1.1
Date:26/06/2023

If used for your research, please credit Aurys Silinga.

https://github.com/DanPorter/i16sim/blob/efb6e1131af703a32e5d307d10f5f57c4fa213d6/i16sim.PNG?raw=true

Features

  • 3D model of the diffractometer with mesh error < 1 mm
  • Collision testing
  • User interface for visualisation of (pseudo-)motor rotations
  • Crystal calculations and movements in hkl space via diffcalc commands
  • Console and script editor for testing experiment scripts
  • Reading nexus data or GDA state files to show diffractometer state during experiment
  • Visualisation of reciprocal lattice vectors and azimuthal reference in the laboratory coordinate system
  • Perspective view from beamline cameras or any point in space

Introduction video

You can watch step-by-step guides to installing the package and using the features. The videos are available on GitHub and on the I16 YouTube channel.

Videos: Installation and Introduction.

Installation

Download Software

  1. Download and install Blender from www.blender.org
  2. Download this repository, specifically i16 full.zip
  3. Unzip the "i16 full.zip" file into a location of your choosing.

Setup Blender python environment

This step configure's the internal Blender python environment and installs required packages.

  1. Open the file i16 full/diffractometer40.blend
  2. In the Blender script editor, open the file i16 full/install/install_i16sim_environment.py
  3. Run the script (using "Run" right-arrow). Check results in Console, should say 'Finished installation' (Windows - use h-bars at top left > Window > Toggle console view) (Linux - look in terminal used to start Blender)
  4. Restart Blender

Install i16sim plugin

  1. Open Preferences (Menu ☰ > Edit > Preferences...)
  2. In the Add-ons tab, click Install..
  3. Select file: i16 full/install/i16sim.zip
  4. Ensure the i16 simulation Add-on is selected.
  5. Installation is complete!

Update i16sim plugin

  1. Download new version of i16full/install/i16sim.zip
  2. In Blender, Open Preferences (Menu ☰ > Edit > Preferences...)
  3. Remove old Add-on i16 simulation (select and press remove)
  4. Install new version from downloaded file.

Documentation

Documentation Status

Full documentation can be found here:

https://i16sim.readthedocs.io/

i16sim's People

Contributors

auryssilinga avatar danporter avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.