Add Sphinx-based Documentation #4
Conversation
…ate setup.py and packageinfo.py * Add Sphinx-based documentation. * Updated README.md so that it is consistent with the documentation. * Update year in copyright statement on LICENSE. * Set OSP_CORE_MAX to v4.0.0.
| The wet synthesis wrappers require a working installation of | ||
| [OpenFOAM 8](https://openfoam.org/version/8/), | ||
| [SUNDIALS](https://github.com/LLNL/sundials) | ||
| ([v6.1.1](https://github.com/LLNL/sundials/releases/tag/v6.1.1) is known to | ||
| work) and [7-zip](https://www.7-zip.org/). Follow the links to find | ||
| installation instructions for each tool. |
There was a problem hiding this comment.
@AndreaQuerio This documentation assumes that only OpenFOAM is compatible, although theoretically, it looks like things shouldm work with Ansys Fluent too, but I cannot test this, so I left it out. If things work with Fluent, please modify the documentation yourself. Be careful, this is not the only place were you would have to mentiont Fluent.
|
@AndreaQuerio The documentation is ready, please review it and add any modifications that you find adequate. Please pay special attention to the correctness of the diagram on the "Usage" section. You can read the documentation here. Every change you push to this branch will be reflected after a few minutes on that page. |
@AndreaQuerio Just a reminder to review what I did and either agree or add any modifications so that the documentation can be merged. |
Replace sklearn by scikit-learn in setup.py
…esis into documentation
Instructions to install solver from Politecnico di Torino will be moved to the repository of the solver and mkl-service will be integrated in setup.py
…esis into documentation
# Conflicts: # docker_install.sh
Adds Sphinx-based documentation.
@AndreaQuerio This documentation is still a draft because a diagram is missing. All the other parts are ready to go. Your review will be requested (and you will get an email notification) when the diagram is ready and the pull request is no longer a draft.