Contributing

Got a feature you would like to see added? Found a bug? This is a v0.0.1 project without a set plan (other than to help you out with your tomography data). You can report an issue by opening one at the issues page. You can suggest an edit to the documentation you are reading right now documentation. You can request a new feature, or even make one yourself and submit a pull request.

Code Improvements

All development for this app happens on GitHub here. You should work with a conda environment.

You should follow the instructions on the Installation page to find out how you can help develop this code. Once you do find out how: make some changes, see if they work, and and tell us about it here.

Seeing your changes

If you are working in a Jupyter Notebook, then in order to see your code changes you will need to either:

• Restart the Kernel every time you make a change to the code.

• Make the function reload from the source file every time you run it by using autoreload, e.g.:

  %load_ext autoreload
  %autoreload 2
  %matplotlib ipympl
  import tomopyui.widgets.main as main
  
  dashboard_output, dashboard, file_import, prep, center, align, recon, dataexplorer = main.create_dashboard("APS") # can be "SSRL_62C", "ALS_832", "APS"
  dashboard_output
  

Working with Git

Using Git/GitHub can be confusing, so if you’re new to Git, you may find it helpful to use a program like GitHub Desktop and to follow a guide.

Also feel free to ask for help/advice on the relevant GitHub issue.

Documentation

The documentation you are reading now is built with Sphinx. There’s plenty to do, and you can help out. If you see something amiss, don’t be afraid to suggest an edit (see the GitHub icon at the top of this page).