Skip to content
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.

Sign up for GitHub

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

Fix doc compilation error #88

Merged
merged 3 commits into from
Jan 21, 2025
Merged

Fix doc compilation error #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fccf38a
fix error in doc and clean up output of doc compile
malihass Jan 21, 2025
bd600ca
fix compile doc
malihass Jan 21, 2025
c0d0161
format
malihass Jan 21, 2025
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ pip install nrel-bird
## Installation of BiRD OpenFOAM solver (for developers and users)

1. Activate your OpenFOAM-9 environment (`source <OpenFOAM-9 installation directory>/etc/<your-shell>rc`)
2. cd `OFsolvers/birdmultiphaseEulerFoam/`
3. `./Allwmake`
2. `cd OFsolvers/birdmultiphaseEulerFoam/`
3. Compile `./Allwmake`

## Documentation

Expand Down
1 change: 0 additions & 1 deletion docs/source/calibration_bsd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,6 @@ Calibrate against the target data obtained with ternary breakup and coalescence
.. |figures-cal-tern-corn| image:: ../assets/calibration/tutorial_bsd/Surr_opt_ternary_corner.png
:width: 49.5%
:alt: Parameter PDF obtained with the surrogate forward model with ternary target data
.. container:: figures-cal-tern


Calibrate against the target data obtained with binary breakup and coalescence
Expand Down
5 changes: 5 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
import os
import sys

import sphinx.util.logging

sphinx.util.logging.getLogger("sphinx").setLevel("ERROR")

# Need this so sphinx can find lumache.py. Change is .py files are elsewhere than root.
sys.path.insert(0, os.path.abspath("../.."))
sys.path.insert(0, os.path.abspath("../../bird"))
Expand Down Expand Up @@ -35,6 +39,7 @@
# 'autoapi.extension',
# 'sphinxcontrib.apidoc',
]

# bibtex_bibfiles = ["references.bib"]
# autoapi_type = 'python'
# autoapi_dirs = ['../../bird']
Expand Down
Loading