doc generation fixed with dummy file

This commit is contained in:
Nicolas Kruse 2025-06-02 17:21:05 +02:00
parent 278ce9ee20
commit ea4ee7821e
3 changed files with 5 additions and 4 deletions

View File

@ -21,6 +21,8 @@ jobs:
run: pip install sphinx sphinx_rtd_theme sphinx-autodoc-typehints myst-parser run: pip install sphinx sphinx_rtd_theme sphinx-autodoc-typehints myst-parser
- name: Generate Class List - name: Generate Class List
run: | run: |
echo "Create a dummy file to ensure the class list generation works"
printf 'gapy\x00\x00\x00\x00' > src/gaspype/data/therm_data.bin
pip install . pip install .
python ./docs/source/generate_class_list.py python ./docs/source/generate_class_list.py
- name: Build Docs - name: Build Docs

View File

@ -1002,10 +1002,9 @@ def carbon_activity(f: fluid | elements, t: float, p: float) -> float:
return exp(lnalpha) return exp(lnalpha)
_oxygen_data = fluid({'O2': 1})
def oxygen_partial_pressure(f: fluid | elements, t: float, p: float) -> FloatArray | float: def oxygen_partial_pressure(f: fluid | elements, t: float, p: float) -> FloatArray | float:
_oxygen_data = fluid({'O2': 1})
def get_oxygen(x: FloatArray) -> float: def get_oxygen(x: FloatArray) -> float:
g_rt = f.fs.get_species_g_rt(t) g_rt = f.fs.get_species_g_rt(t)
g_rt_o2 = _oxygen_data.fs.get_species_g_rt(t)[0] g_rt_o2 = _oxygen_data.fs.get_species_g_rt(t)[0]

View File

@ -31,7 +31,7 @@ General syntax is: ```python compile_to_bin.py YAML_INPUT_FILE BINARY_OUTPUT_FIL
The binary format is structured like this, it uses little-endian and IEEE 754 floats: The binary format is structured like this, it uses little-endian and IEEE 754 floats:
``` ```
[4 Byte magic number: 'gapy'] [4 Byte magic number: 'gapy']
[8 Byte: 32 Bit integer for length of all species names (NAMES_LENGTH)] [4 Byte: 32 Bit integer for length of all species names (NAMES_LENGTH)]
[NAMES_LENGTH Bytes: ASCII encoded string with all species names separated by space] [NAMES_LENGTH Bytes: ASCII encoded string with all species names separated by space]
[Index [Index
[For each species [For each species