Clean up precipitator and documentation #62
Conversation
agarciadiego
added
Priority:Normal
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #62 +/- ##
==========================================
+ Coverage 95.85% 95.89% +0.03%
==========================================
Files 31 31
Lines 5041 5037 -4
==========================================
- Hits 4832 4830 -2
+ Misses 209 207 -2 ☔ View full report in Codecov by Sentry. |
Co-authored-by: Ludovico Bianchi <lbianchi@lbl.gov>
|
|
||
| where :math:`n_{t,prec,c}` is the outlet precipitacion of c component, :math:`n_{t,aq_in,c}` is the inlet of c comp in | ||
| the aqueous phase, :math:`n_{t,aq_in,c}` is the outlet of c comp in the aqueous phase at time :math:`t`, divided by the | ||
| stechiometric parameter of component c :math:'{S{comp}' |
There was a problem hiding this comment.
| stechiometric parameter of component c :math:'{S{comp}' | |
| stechiometric parameter of component c :math:`S{comp}` |
There was a problem hiding this comment.
Also - stoichiometric is spelt incorrectly.
There was a problem hiding this comment.
I've added it for consideration for the next update to our favorite spellchecker: crate-ci/typos#956 (comment) (not sure if or when it'll become active, though, so we'll need to check for it manually until then)
|
@agarciadiego Python modules should be added to API Reference
=============
Leaching
--------
.. autosummary::
:toctree: _autosummary
prommis.leaching.leach_reactions
prommis.leaching.leach_solids_properties
prommis.leaching.leach_solution_properties
Roasting
--------
.. autosummary::
:toctree: _autosummary
prommis.roasting.ree_feed_roaster
prommis.roasting.ree_oxalate_roaster
Precipitate
-----------
.. autosummary::
:toctree: _autosummary
prommis.precipitate.precipitator
prommis.precipitate.precipitate_liquid_properties
prommis.precipitate.precipitate_liquid_properties |
|
@lbianchi-lbl Does that mean that the new LeachTrain model/class should be added here as well? |
I've just checked and yes, I think the module |
I'll add it in this PR |
|
@agarciadiego Thank you. |
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
|
The formatting of the leach train documentation got a bit messed up as a result of the indents. Other than this, the PR LGTM.
|
ksbeattie
added
Priority:High
| @@ -1204,22 +1194,13 @@ | |||
| "WARNING (W1002): Setting Var 'fs.leach.liquid[0.0,2].conc_mol_comp[Dy]' to a\n", | |||
There was a problem hiding this comment.
Can these warnings be resolved, or hidden?
There was a problem hiding this comment.
I could skip the validation of the variables. However, I don't know if this would be a positive change. Maybe we should add an issue. What do you think @MarcusHolly
There was a problem hiding this comment.
We can create an issue in the spirit of getting this PR merged today or tomorrow.
| ] | ||
| } | ||
| ], | ||
| "outputs": [], | ||
| "source": [ | ||
| "# This display needs to be replaced with m.fs.roaster.report() when available\n", |
There was a problem hiding this comment.
There is an extra empty cell at the end of the notebook.
Addresses Issue:
Adds documentation to preliminary precipitator model.
Summary/Motivation:
Changes proposed in this PR:
Legal Acknowledgement
By contributing to this software project, I agree to the following terms and conditions for my contribution:
I agree my contributions are submitted under the license terms described in the LICENSE.md file
at the top level of this directory.
I represent I am authorized to make the contributions and grant the license. If my employer has
rights to intellectual property that includes these contributions, I represent that I have
received permission to make contributions and grant the required license on behalf of that
employer.