Skip to content

Commit 49e3ab9

Browse files
committed
Added readthedocs setup yaml to hopefully fix doc compile issues
Updated func_multimodal config script to specify the module
1 parent fda242f commit 49e3ab9

2 files changed

Lines changed: 40 additions & 3 deletions

File tree

.readthedocs.yaml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
# Required
4+
version: 2
5+
# Set the OS, Python version and other tools you might need
6+
build:
7+
os: ubuntu-22.04
8+
tools:
9+
python: "3.12"
10+
# You can also specify other tool versions:
11+
# nodejs: "20"
12+
# rust: "1.70"
13+
# golang: "1.20"
14+
15+
# Build documentation in the "docs/" directory with Sphinx
16+
sphinx:
17+
18+
configuration: sphinx/source/conf.py
19+
20+
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
21+
# builder: "dirhtml"
22+
# Fail on all warnings to avoid broken references
23+
# fail_on_warning: true
24+
25+
26+
# Optionally build your docs in additional formats such as PDF and ePub
27+
# formats:
28+
# - pdf
29+
# - epub
30+
31+
# Optional but recommended, declare the Python requirements required
32+
# to build your documentation
33+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
34+
35+
# python:
36+
# install:
37+
# - requirements: docs/requirements.txt

benchmark_suite/func_multimodal/chimbuko_config.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
#IMPORTANT NOTE: Variables that cannot be left as default are marked as <------------ ***SET ME***
55

6-
service_node_iface=eth0 #network interface upon which communication to the service node is performed <------------ ***SET ME***
6+
module="performance_analysis"
77

88
####################################
99
#Options for visualization module
@@ -12,7 +12,7 @@ use_viz=0 #enable or disable the visualization
1212
viz_root=$(spack location -i chimbuko-visualization2) #the root directory of the visualization module <------------ ***SET ME (if using viz)***
1313
viz_worker_port=6379 #the port on which to run the redis server for the visualization backend
1414
viz_port=5002 #the port on which to run the webserver
15-
export C_FORCE_ROOT=1 #required only for docker runs, allows celery to execute properly as root user <----------------- *** SET ME (if using Docker)
15+
#export C_FORCE_ROOT=1 #required only for docker runs, allows celery to execute properly as root user <----------------- *** SET ME (if using Docker)
1616

1717
############################################################
1818
#General options for Chimbuko backend (pserver, ad, provdb)
@@ -27,7 +27,7 @@ use_provdb=1 #enable or disable the provDB. If disabled the provenance data will
2727
provdb_extra_args="" #any extra command line arguments to pass
2828
provdb_nshards=4 #number of database shards
2929
provdb_ninstances=1 #number of database server instances. Shards are distributed over instances
30-
provdb_engine="ofi+tcp;ofi_rxm" #the OFI libfabric provider used for the Mochi stack
30+
provdb_engine="sockets" #the OFI libfabric provider used for the Mochi stack
3131
provdb_port=5000 #the port of the provenance database. For >1 instance the port of instance i will be provdb_port+i
3232
provdb_writedir=chimbuko/provdb #the directory in which the provenance database is written. Chimbuko creates chimbuko/provdb which can be used as a default
3333
provdb_commit_freq=10000 #frequency ms at which the provenance database is committed to disk. If set to 0 it will commit only at the end

0 commit comments

Comments
 (0)