-
Notifications
You must be signed in to change notification settings - Fork 108
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 installation and add FAQ. Handle warnings #146
Conversation
There were some minor code changes, but mostly docs here. I suggest checking out this branch locally and |
docs/faq.rst
Outdated
---------------------------------------------------------- | ||
|
||
This is an upstream bug in sympy, where floats are unable to be pickled. | ||
The fix has been copmleted, but not yet released. While the fix is not released, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
spelling
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.
5dcd5ba
to
b47de13
Compare
|
I think with the state of the solver, Al-Ni is a better looking example to show rather than Al-Fe. As far as the masking, the |
Either phase diagram is fine. We just need to make sure the link on the front page is correct. |
TODO: Add notes on units in the FAQ |
This is ready for another look |
Merge when ready. |
* WIP: #126 install docs * DOC: Update installation instructions * DOC: Add FAQ and address parallelism * DOC: Add notes about equilibrium computation time to FAQ * DOC: Add argument is not an mpz to FAQ * ENH: Filter NumPy warnings for dividing by zero and invalid values in true divide * MAINT: Silence dask async deprication warning and bump requirements 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. * DOC: Add matplotlib text cut off fix to FAQ * DOC: Add using calculation results example for xarray Datasets * DOC: Fix several spelling errors * DOC: Update examples titles * DOC: Regenerate API docs for removed modules * DOC: Fix homepage image (AL-NI), minor spelling corrections * DOC: Update UsingCalculationResults to use .values (NumPy) * DOC: Add units to FAQ
* Link to Miniconda3 downloads * Include discussion of JupyterLab installation * Windows users: Git installation * Development instructions make an environment
Fixes gh-126, fixes gh-128, fixes gh-134, and fixes gh-139
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.).
#139: Addressed simultaneously with #126
#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.