Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update simulation module with latest simulation software versions. #46

Open
3 tasks
PinkShnack opened this issue Jun 20, 2021 · 0 comments
Open
3 tasks
Labels
enhancement New feature or request

Comments

@PinkShnack
Copy link
Owner

Problem

-The current simulation module isn't very modular in that it relies on certain external packages and isn't easily extensible for new packages (e.g. ABTEM), which users might like to use. Therefore its functions need to be broken up and a generalised 'simulate' function should be implemented with the software to be used as a parameter e.g. def simulate(software='prismatic', algorithm='multislice' ... .
-The current TEMUL Toolkit functionality for dealing with simulations is limited to pyprismatic version 0.1.1 (an old one).
It has updated its file format use and we should keep up.

What needs to be done

  • Break up simulation functions so that there are general ones for running simulations and specific ones that handle each software (e.g. pyprismatic, abtem).
  • Warp these general functions as methods in the Model Refiner class for ease-of-use.
  • Add simulation parameters as a dictionary attribute in the Model Refiner class. Then, the user just has to set all parameters in the model refiner as a dict and is free to simulate with whatever software they wish. By parameters here I mean simulation parameters, not python parameters.
@PinkShnack PinkShnack added the enhancement New feature or request label Jun 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant