Developers Notes

Pystack3D is a new project (started in 2021).

Developers are warmly encouraged to collaborate and contribute to the ongoing improvement of Pystack3D. Contributions are welcome in the form of bug reports, documentation, code , feature requests, and more…

Issues

The issue tracker can be used to report bugs or propose new features. When reporting a bug, the following is useful:

  • give a minimal example demonstrating the bug,

  • copy and paste the error traceback.

Pull Requests

If you want to contribute to improve the Pystack3D source code, you can send us a pull request against the main branch. Small bug fixes and corrections to the user guide are typically a good starting point. But don’t hesitate also for significant code contributions, such as support for a new file format - if needed, we’ll help you to get the code ready to common standards.

TODO List

  • add a GUI

  • (registration) consider a non-rigid transformation representing the drift during a frame scan

  • (intensity rescaling) take into account beam source variation