Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Update installation and add FAQ. Handle warnings #146
Regarding points in #126:
This PR updates the installation guide with step by step instructions for all platforms, but emphasizing Anaconda. It is now more clear that you can use either distribution to install pycalphad.
The installation includes the caveats of the Ipopt installation situation for pip installation and develop mode, as well as a Anaconda alternative to develop mode.
This is in the newly added FAQ
A brief statement of computation time and the implications for binplot/ternplot were added to the FAQ.
I did not handle the convergence failures (Ipopt should make them more rare). This commit explicitly adds code to filter out the NumPy warnings and fixes the dask import warning that users have been seeing and bumps the dask version accordingly. (Python 3.7 will make async a keyword (see https://bugs.python.org/issue30406). This means dask had to rename their async module to local to avoid having a module name be a keyword and users have been seeing warnings about the import. This commit updates the import from dask.async.get_sync to dask.local.get_sync and bumps the requirements to dask>=0.15.).
#128: added to FAQ
#134: Added a UsingCalculationResults example notebook (and generated docs) that goes through the calculate and equilibrium datasets and describes them fully. Also provides some brief examples of how one would select and mask using xarray.
There were some minor code changes, but mostly docs here. I suggest checking out this branch locally and