search

ORNL / Equilipy

Open-source python package for multicomponent multiphase equilibrium CALPHAD calculations
https://ornl.github.io/Equilipy/
BSD 3-Clause "New" or "Revised" License
9 stars 2 forks source link

[JOSS review] Examples - add recommends or edit #3

Closed mefuller closed 1 month ago

mefuller commented 2 months ago

Example 3 requires the fastexcel package as currently provided. It would be beneficial, but not critical, to add this as a recommended install under the example web documentation and/or rewrite the example to read from a csv or otherwise not require any additional packages

lanari commented 2 months ago

I noticed this problem too, and it would be good to add in the README that some examples require fastexcel and give the command pip install fastexcel.

SunyongKwon commented 2 months ago

Thank you so much for the feedback. I update the documentation for preinstalling fastexcel: please see Depenancy to Polars under Preinstall in web documentation (https://ornl.github.io/Equilipy/preinstall.html) and Additional note in README.md file.

Let me know if i can close this issue.