How to test savu pluginΒΆ

Tunhe Zhou

Tunhe Zhou : How to test savu plugin
  1. set github local repository, follow this instruction: https://savu.readthedocs.io/en/latest/dev_guides/dev_github/
  2. make the plugins in the folder of plugin, for example: hilbert_filter.py
  3. change the savu path to the github savu folder:
    export SAVUHOME=/home/btq48787/github/Savu
  4. then
    module load savu
    savu_config
    list
    the new plugin should show in the list
  5. create a simple process list, for example with only NxtomoLoader and the new plugin. save it outside the github folder somewhere.
  6. run savu with the test process list and test data in /home/btq48787/github/Savu/test_data/data/24737.nxs
  7. If everything is fine. Open an example test file in /home/btq48787/github/Savu/savu/test/travis/plugin_tests/filter_tests
    Use it as template to make a process_test python file for the new plugin.
    save the process_list nxs file to /home/btq48787/github/Savu/test_data/test_process_lists
    in terminal window:
    test_setup.sh
    python the_new_process_test.py
    If it runs through, then it's fine. We can push it on to github.
  8. git status
    it should show that we have 3 more files now: one python for new plugin, one nxs for process list, one python for test plugin
    git add all the files
    git status
    they should look green now
    git commit -m "message for the change"
    git pull upstream master
    to update to the newest version from the diamond light source. If there were a lot of changes. might need to test again to see if the plugin works
    git push origin master
    push the changes to the master branch of my fork.
  9. on github webpage, pull request to diamond for changes