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 instructions on input data format #108

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

RunzeZhang123
Copy link
Collaborator

Placeholder to add better instructions on the input data formatting.

@ma-sadeghi
Copy link
Collaborator

Hi @RunzeZhang123, here's what I think should be addressed in this PR:

  • Explain what's required by AutoEIS as input
  • Introduce pyimpspec package and list supported formats (check their documentation)
  • Add an example of using pyimpspec to load EIS data from a proprietary data fromat and convert to the inputs required by AutoEIS (i.e., freq and complex impedance arrays)
  • Bonus: Add a minimal example notebook for above (using pyimpsec) and put it under examples/ folder, so we can include it in our automated test suite (this way, we'll know if there's a breaking API change)

Preferably all in a single markdown file. Feel free to add more items if I missed anything.

@ma-sadeghi ma-sadeghi self-requested a review April 19, 2024 19:11
Copy link
Collaborator

@ma-sadeghi ma-sadeghi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work. Here are the things that would make the document more manageable:

  • Make it a proper ipynb file, and the code snippet a proper python code cell
  • Download 3 sample datasets from pyimpspec tests folder and actually load the data and visualize using autoeis to show users how to work with real data (data coming from real EIS devices)
  • Dump the toy datasets into AutoEIS/src/assets and access it via utils.get_assets_folder()

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

Successfully merging this pull request may close these issues.

2 participants