Docs for domain decomposition and parallel programming proof of concept implementation #127
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
To do:
|
Some small textual changes
Sierd
approved these changes
Jul 12, 2023
manuGil
added a commit
that referenced
this pull request
Jul 12, 2023
* WIP: Placeholder for parallel solver documentation. * rerun short grid files example and remove/keep reference to it * update content for short grid example * fix typos and grammatical erros * Results captured in tabular form for comparison and readability * fix warning for undefined language * remove napoleon dependency, is not packed with sphinx * add sphinx-copybutton as dependency * include extension copybutton * fixe undershoot underlining * include sphinxxontrib.bibtex extension in docs * fix error with broken enumarated list * commented import of bibtex file. Now is loaded by config.py * include condifuration file * remove path to stacic content. It wasn't used * fixe missing package plot * use latest version of aerolis to build docs * fixed issue with duplicated lables for branch * add implementation details with code snippets * Fixes to Documentation (#131) * remove reference to old branch * update insallaiton instruction in docs * update intallation file in docs * fix reference to equilibrium equation * include python 3.11 in CI * add note on Windows installation * Bumper to home page (#132) * remove reference to old branch * update insallaiton instruction in docs * update intallation file in docs * fix reference to equilibrium equation * include python 3.11 in CI * add note on Windows installation * fixe bibtype issues * include bibliography in separated file * remove youtube extension * change main title * include version for bitex extension * add files for extending documentation * Docs for domain decomposition and parallel programming proof of concept implementation (#127) * Fix typo. Specify minimum version of the Sphinx bibliography extension * Update domain_decomposition.rst Some small textual changes --------- Co-authored-by: Sierd <Sierd.deVries@tudelft.nl> * Updates to the Dev documentation (#133) * change author and CR to Aeolis team * frix wrong version for bibtex extension * include AeoLiS in requirements.txt * move quicstart to developer directory * write documentation for quickstart * update location of quickstart for developers * add reference lavel for installation section * fix malform code block * rename RST file for unit tests * add warning to quickstart.rst * first draft for unit testing section * change recomendation to Numpy docstrings --------- Co-authored-by: Niket Agrawal <15953349+niketagrawal@users.noreply.github.com> --------- Co-authored-by: Manuel G. Garcia <gilbert.mg22@gmail.com> Co-authored-by: Sierd <Sierd.deVries@tudelft.nl>
niketagrawal
added a commit
that referenced
this pull request
Sep 13, 2023
* WIP: Placeholder for parallel solver documentation. * rerun short grid files example and remove/keep reference to it * update content for short grid example * fix typos and grammatical erros * Results captured in tabular form for comparison and readability * fix warning for undefined language * remove napoleon dependency, is not packed with sphinx * add sphinx-copybutton as dependency * include extension copybutton * fixe undershoot underlining * include sphinxxontrib.bibtex extension in docs * fix error with broken enumarated list * commented import of bibtex file. Now is loaded by config.py * include condifuration file * remove path to stacic content. It wasn't used * fixe missing package plot * use latest version of aerolis to build docs * fixed issue with duplicated lables for branch * add implementation details with code snippets * Fixes to Documentation (#131) * remove reference to old branch * update insallaiton instruction in docs * update intallation file in docs * fix reference to equilibrium equation * include python 3.11 in CI * add note on Windows installation * Bumper to home page (#132) * remove reference to old branch * update insallaiton instruction in docs * update intallation file in docs * fix reference to equilibrium equation * include python 3.11 in CI * add note on Windows installation * fixe bibtype issues * include bibliography in separated file * remove youtube extension * change main title * include version for bitex extension * add files for extending documentation * change author and CR to Aeolis team * frix wrong version for bibtex extension * include AeoLiS in requirements.txt * move quicstart to developer directory * write documentation for quickstart * update location of quickstart for developers * add reference lavel for installation section * fix malform code block * rename RST file for unit tests * add warning to quickstart.rst * first draft for unit testing section * Docs for domain decomposition and parallel programming proof of concept implementation (#127) * Fix typo. Specify minimum version of the Sphinx bibliography extension * Update domain_decomposition.rst Some small textual changes --------- Co-authored-by: Sierd <Sierd.deVries@tudelft.nl> * change recomendation to Numpy docstrings * Updates to the Dev documentation (#133) * change author and CR to Aeolis team * frix wrong version for bibtex extension * include AeoLiS in requirements.txt * move quicstart to developer directory * write documentation for quickstart * update location of quickstart for developers * add reference lavel for installation section * fix malform code block * rename RST file for unit tests * add warning to quickstart.rst * first draft for unit testing section * change recomendation to Numpy docstrings --------- Co-authored-by: Niket Agrawal <15953349+niketagrawal@users.noreply.github.com> * updatedocstring streamformatter * review unittest example * Manuel docs (#135) * change author and CR to Aeolis team * frix wrong version for bibtex extension * include AeoLiS in requirements.txt * move quicstart to developer directory * write documentation for quickstart * update location of quickstart for developers * add reference lavel for installation section * fix malform code block * rename RST file for unit tests * add warning to quickstart.rst * first draft for unit testing section * change recomendation to Numpy docstrings * updatedocstring streamformatter * review unittest example --------- Co-authored-by: Niket Agrawal <15953349+niketagrawal@users.noreply.github.com> * update use case * add tutorials section and placeholder documents * update workflow title * apa like bib style * fix issue with images as PDF * change name of class to ApaLike * functional test is the correct terminology for the two current black-box tests. Take bottom up and tuorial style approach to describing software tests * testing intro doc should provide answers to the fundamental questions on software tests * add console output of test execution in docs * rename sections, remove old content * add to do list for functional testing doc * Regression test is the right terminology for the black box test that we run against new code changes. Functional testing is more than just black box testing and concerns with testing certain functional specifications. * Add comments in regression tests source code instead of describing the behavior in docs * fix cross referencing * fix typo * describe implementation of tests using comments, rename functions to improve readability. * add missing modules to index and docs. Fixes #146 * update ref and bib style. Fixes #138 * add dependency for jupyter notebooks * add extension for jupyter notebooks * refactor aeolis_debug function * refactor run_console.py * update function description * add debug modules to documentation * update initialize function description * make Sied's fav function a note * remove short course notebooks * move rst files to user directory and update refs * add dependency list to installation doc * include depencies for documentation * update section on software testing * review intro to testing * complete section on unit testing * format code in TestStreamFormatter * pinned version of sphix to <7, fixes #153 * use lower case name for aeolis * upgrade t2.1.3 * update modularity section in docs * fix use of bad typings --------- Co-authored-by: Niket <15953349+niketagrawal@users.noreply.github.com> Co-authored-by: Sierd <Sierd.deVries@tudelft.nl>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.