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

Add more examples for JOSS review #111

Closed
3 of 5 tasks
ma-sadeghi opened this issue Apr 12, 2024 · 7 comments · Fixed by #123
Closed
3 of 5 tasks

Add more examples for JOSS review #111

ma-sadeghi opened this issue Apr 12, 2024 · 7 comments · Fixed by #123
Labels
documentation Improvements or additions to documentation

Comments

@ma-sadeghi
Copy link
Collaborator

ma-sadeghi commented Apr 12, 2024

  • Circuits basics
  • Built-in circuit library
  • Advanced analysis of AutoEIS output
  • Analyze batch data
  • Break up generic workflow notebook into sub-notebooks for readability
@ma-sadeghi ma-sadeghi added the documentation Improvements or additions to documentation label Apr 12, 2024
@RunzeZhang123
Copy link
Collaborator

Case A. it might be helpful to showcase how to create customized circuits and apply AutoEIS on them.

Basiclly, it could contain the following steps:

  1. demonstrate how to create a customized circuits composed of multiple elements
  2. add a function to validate the created circuits
  3. put it into AutoEIS
  4. show the results

@RunzeZhang123
Copy link
Collaborator

Case B. we could also consider to build a customized circuits library. We can start this by collecting well-examined ECMs from published papers, then classify them according to their systems. Then provide an exmaple file to showcase how to properly load them.

Further, we can think of how to allow users to build their own customized circuit libraries so that they can examine these ECMs convinenetly as well

@RunzeZhang123
Copy link
Collaborator

Case C. might be helpful to further demonstrate what useful aspects we can extract from AutoEIS's final outputs. (i.e. the mcmc objects). Therefore, except for visualizing them using the functions written by us, they can also customize the plotting processes to suit their purpose, or examine the results from more dimensions.

@RunzeZhang123
Copy link
Collaborator

Feel free to leave your comments here. I'm more than happy to accomplish these tasks.

@RunzeZhang123
Copy link
Collaborator

Case D. Might also be helpful to illustrate how to apply AutoEIS to analyze batch data.

@RunzeZhang123
Copy link
Collaborator

Follow-up on Case C. Currenlty we miss a clear illustration on how to filter out non-physical models, and to prioritize the statistically plausible models. Also, we lack a demonstration on how to extract the most likely circuit parameters from BI results. (probably a figure with a table to visualize the circuits with most likely values could be helpful.)

@ma-sadeghi
Copy link
Collaborator Author

These are good ideas @RunzeZhang123, I added them to the todo list in the first comment. I can do "Circuit basics" (work in progress) and "Analyze batch data", and you can take up "Built-in circuit library" and "Advanced analysis of AutoEIS output". Does that work for you?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants