Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,10 @@ build:
python: "3.13"
jobs:
post_build:
- mkdir -p $READTHEDOCS_OUTPUT/html/files
- cp $READTHEDOCS_OUTPUT/pdf/openstream.pdf $READTHEDOCS_OUTPUT/html/files/OpenSTREAM.pdf
- |
PDF_FILE_SRC="$READTHEDOCS_OUTPUT/pdf/openstream.pdf"
PDF_FILE_DST="$READTHEDOCS_OUTPUT/html/files/OpenSTREAM.pdf"
if [ -f "$PDF_FILE_SRC" ]; then
mkdir -p $READTHEDOCS_OUTPUT/html/files
cp "$PDF_FILE_SRC" "$PDF_FILE_DST"
fi
6 changes: 3 additions & 3 deletions docs/source/Applications/database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -269,9 +269,9 @@ OpenSTREAM-database requires:

OpenSTREAM is maintained as a separate repository and must be installed
independently. Consult the
`OpenSTREAM installation guide
<https://openstream-solvers.github.io/openstream/Usage/gettingStarted.html>`_
for the current MATLAB, Python, CoolProp, and installation requirements.
:doc:`OpenSTREAM installation guide
<Usage/gettingStarted>` for the current MATLAB, Python, CoolProp, and
installation requirements.

Installation
------------
Expand Down
4 changes: 2 additions & 2 deletions docs/source/Applications/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The workflow reproduces selected calculations and results from the paper:
- Figure 7: developing disturbance-wave validation using ``Sawai1989``.

`Open the completed NURETH21 companion workflow
<https://openstream-solvers.github.io/openstream/_static/html/project_NURETH21.html>`_
<https://openstream.readthedocs.io/en/latest/_static/html/project_NURETH21.html>`_


NUTHOS-15 MRM
Expand All @@ -80,7 +80,7 @@ The workflow reproduces selected calculations and results from the paper:
``Becker1983`` post-boiling-transition cases.

`Open the completed NUTHOS15_MRM companion workflow
<https://openstream-solvers.github.io/openstream/_static/html/project_NUTHOS15_MRM.html>`_
<https://openstream.readthedocs.io/en/latest/_static/html/project_NUTHOS15_MRM.html>`_

----

Expand Down
18 changes: 9 additions & 9 deletions docs/source/Guides/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ through the links below.
--------------

`Open Tutorial 1: Quick Start
<https://openstream-solvers.github.io/openstream/_static/html/tutorial01_quick_start.html>`_
<https://openstream.readthedocs.io/en/latest/_static/html/tutorial01_quick_start.html>`_

Run a provided OpenSTREAM case using the mixture, two-fluid, three-field,
and four-field solver frameworks. This tutorial introduces input loading,
Expand All @@ -37,7 +37,7 @@ users.
------------------------------

`Open Tutorial 2: Mixture Solver Capabilities
<https://openstream-solvers.github.io/openstream/_static/html/tutorial02_mixture.html>`_
<https://openstream.readthedocs.io/en/latest/_static/html/tutorial02_mixture.html>`_

Explore homogeneous and nonhomogeneous mixture formulations, including
fixed-slip and drift-flux models. The tutorial also introduces empirical
Expand All @@ -50,7 +50,7 @@ calculation.
--------------------------------

`Open Tutorial 3: Two-Fluid Solver Capabilities
<https://openstream-solvers.github.io/openstream/_static/html/tutorial03_twofluid.html>`_
<https://openstream.readthedocs.io/en/latest/_static/html/tutorial03_twofluid.html>`_

Construct and run two-fluid calculations with separate liquid and vapor
fields. Examine phase mass flow rates, velocities, enthalpies,
Expand All @@ -63,7 +63,7 @@ and physical transient behavior.
----------------------------------

`Open Tutorial 4: Three-Field Solver Capabilities
<https://openstream-solvers.github.io/openstream/_static/html/tutorial04_threefield.html>`_
<https://openstream.readthedocs.io/en/latest/_static/html/tutorial04_threefield.html>`_

Model annular flow using separate liquid-film and entrained-droplet fields
together with the mixture-model vapor solution. Compare onset-of-annular-
Expand All @@ -76,7 +76,7 @@ pseudo-time convergence, and transient behavior.
---------------------------------

`Open Tutorial 5: Four-Field Solver Capabilities
<https://openstream-solvers.github.io/openstream/_static/html/tutorial05_fourfield.html>`_
<https://openstream.readthedocs.io/en/latest/_static/html/tutorial05_fourfield.html>`_

Extend the three-field formulation by separating the liquid film into
base-film and disturbance-wave fields. Examine film decomposition, wave
Expand All @@ -89,7 +89,7 @@ terms, pseudo-time convergence, and a physical transient calculation.
--------------

`Open Tutorial 6: Input Files
<https://openstream-solvers.github.io/openstream/_static/html/tutorial06_inputfiles.html>`_
<https://openstream.readthedocs.io/en/latest/_static/html/tutorial06_inputfiles.html>`_

Learn how OpenSTREAM cases are assembled from physical-model, numerical-
option, geometry, and boundary-condition inputs. This tutorial demonstrates
Expand All @@ -102,7 +102,7 @@ files to JSON.
-----------------------------------------------

`Open Tutorial 7: Numerical Convergence and Solver Diagnostics
<https://openstream-solvers.github.io/openstream/_static/html/tutorial07_convergence.html>`_
<https://openstream.readthedocs.io/en/latest/_static/html/tutorial07_convergence.html>`_

Distinguish local pointwise convergence, pseudo-time convergence, and
physical-time advancement. Inspect solver states and initialization
Expand All @@ -115,7 +115,7 @@ converged solution is numerically consistent.
---------------------------------

`Open Tutorial 8: Mesh and Time-Step Sensitivity
<https://openstream-solvers.github.io/openstream/_static/html/tutorial08_meshandtimestep.html>`_
<https://openstream.readthedocs.io/en/latest/_static/html/tutorial08_meshandtimestep.html>`_

Evaluate the sensitivity of mixture-solver results to spatial and temporal
discretization. Compare steady-state solutions calculated with different
Expand All @@ -129,7 +129,7 @@ sensitivity assessment and a systematic convergence study.
---------------------------------------------

`Open Tutorial 9: Advanced Visualization and Post-Processing
<https://openstream-solvers.github.io/openstream/_static/html/tutorial09_visualization.html>`_
<https://openstream.readthedocs.io/en/latest/_static/html/tutorial09_visualization.html>`_

Apply the principal OpenSTREAM visualization and post-processing
capabilities to a transient solution. Generate animated axial
Expand Down
4 changes: 2 additions & 2 deletions docs/source/_static/html/project_NURETH21.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/source/_static/html/project_NUTHOS15_MRM.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/source/my_bib.bib
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ @inproceedings{LeCorre2026MRM
address = {Kashiwa-no-ha, Japan},
month = {September 28--October 1},
year = {2026},
url = {https://openstream-solvers.github.io/openstream/_static/publications/LeCorre2026MRM.pdf},
url = {https://openstream.readthedocs.io/en/latest/_static/publications/LeCorre2026MRM.pdf},
keywords = {mixture}
}

Expand All @@ -34,7 +34,7 @@ @inproceedings{LeCorre2025OpenSTREAM
year = {2025a},
address = {Busan, Korea},
month = {August 31--September 5},
url = {https://openstream-solvers.github.io/openstream/_static/publications/LeCorre2025OpenSTREAM.pdf},
url = {https://openstream.readthedocs.io/en/latest/_static/publications/LeCorre2025OpenSTREAM.pdf},
keywords = {overview}
}

Expand All @@ -45,7 +45,7 @@ @inproceedings{Dunbar2025
year = {2025},
address = {Busan, Korea},
month = {August 31--September 5},
url = {https://openstream-solvers.github.io/openstream/_static/publications/Dunbar2025.pdf},
url = {https://openstream.readthedocs.io/en/latest/_static/publications/Dunbar2025.pdf},
keywords = {threefield}
}

Expand All @@ -56,7 +56,7 @@ @inproceedings{LeCorre2025ICMF
year = {2025b},
address = {Toulouse, France},
month = {May 12--16},
url = {https://openstream-solvers.github.io/openstream/_static/publications/LeCorre2025ICMF.pdf},
url = {https://openstream.readthedocs.io/en/latest/_static/publications/LeCorre2025ICMF.pdf},
keywords = {overview}
}

Expand All @@ -67,7 +67,7 @@ @inproceedings{Chan2025
year = {2025},
address = {Toulouse, France},
month = {May 12--16},
url = {https://openstream-solvers.github.io/openstream/_static/publications/Chan2025.pdf},
url = {https://openstream.readthedocs.io/en/latest/_static/publications/Chan2025.pdf},
keywords = {threefield,fourfield}
}

Expand All @@ -78,7 +78,7 @@ @inproceedings{Walter2025
year = {2025},
address = {Toulouse, France},
month = {May 12--16},
url = {https://openstream-solvers.github.io/openstream/_static/publications/Walter2025.pdf},
url = {https://openstream.readthedocs.io/en/latest/_static/publications/Walter2025.pdf},
keywords = {twofluid}
}

Expand Down
Loading