Where to find examples: Difference between revisions

From STIR
stir>Krthie
first version
 
stir>Krthie
added recon_test_pack
Line 14: Line 14:
which will report something like ''C:\Users\kris\miniconda3\envs\stir\Library\share\stir\config''. Go 2 folders up and find it in the ''doc'' folder, e.g. in my case ''C:\Users\kris\miniconda3\envs\stir\Library\share\doc\stir-5.1''.
which will report something like ''C:\Users\kris\miniconda3\envs\stir\Library\share\stir\config''. Go 2 folders up and find it in the ''doc'' folder, e.g. in my case ''C:\Users\kris\miniconda3\envs\stir\Library\share\doc\stir-5.1''.


In the source, you can also find the ```recon_test_pack```, which could be useful for more advanced users. Note that its scripts and parameter files are '''not''' intended as examples, but for testing behaviour.


Please also check the (by now somewhat old but hopefully still useful) STIR-exercises at https://github.com/UCL/STIR-exercises
Please also check the (by now somewhat old but hopefully still useful) STIR-exercises at https://github.com/UCL/STIR-exercises

Revision as of 08:31, 9 March 2023

The STIR documentation is probably not enough to get you going. We therefore have same explicit examples. You can find these as follows

  • On GitHub https://github.com/UCL/STIR/tree/master/examples/ (you might need to check the version and switch to the appropriate release)
  • If you downloaded the STIR source, in STIR/examples
  • If you used conda (or another way to get a pre-compiled version of STIR):
    • since STIR 5.1
  stir_config --examples-dir
    • STIR 5.0 (or a conda version where the above gives the incorrect location)
  stir_config --config-dir

which will report something like C:\Users\kris\miniconda3\envs\stir\Library\share\stir\config. Go 2 folders up and find it in the doc folder, e.g. in my case C:\Users\kris\miniconda3\envs\stir\Library\share\doc\stir-5.1.

In the source, you can also find the ```recon_test_pack```, which could be useful for more advanced users. Note that its scripts and parameter files are not intended as examples, but for testing behaviour.

Please also check the (by now somewhat old but hopefully still useful) STIR-exercises at https://github.com/UCL/STIR-exercises