This repository provides a suite of tutorials and demos on how to use the ROM tools and workflows Python library.
Specifically, we provide tutorials for
- Basis construction
- Parameter spaces
- Workflows
These steps outline how to build the documentation manually.
- Begin by installing the
romtools
package:
git clone https://github.com/Pressio/rom-tools-and-workflows.git
pip install -e rom-tools-and-workflows
- Then clone the
rom-tools-and-workflows-demos
repo and navigate to thedocs
directory
git clone https://github.com/Pressio/rom-tools-and-workflows-demos.git
cd rom-tools-and-workflows-demos/docs
- Install dependencies
pip install -r build_requirements.txt
- Generate the documentation
make html
This will create a new generated_docs
directory.
- Open the generated
index.html
with your desired browser. For example, to use Firefox, run:
firefox generated_docs/index.html