firesim/docs
Tim Snyder e2135d6cfe add --platform and reloacate awsinit
managerinit now requires a --platform flag that defaults to f1
awsinit is moved into awstools.py
updated docs to remove references to awsinit
2022-04-18 19:46:46 +00:00
..
Advanced-Usage add --platform and reloacate awsinit 2022-04-18 19:46:46 +00:00
Developer-Docs [docs] Port docs to use new gh-file-ref role 2022-04-04 19:05:39 -07:00
Golden-Gate Add a Developer Section to docs.fires.im (#1004) 2022-04-04 11:33:00 -07:00
Initial-Setup add --platform and reloacate awsinit 2022-04-18 19:46:46 +00:00
Running-Simulations-Tutorial 1st pass on docs 2022-02-05 01:03:38 +00:00
_static add a logo 2020-02-10 04:14:50 +00:00
graffle-src/metasim-module-hierarchy.graffle Update MIDAS-level -> metasimulation naming in docs (#822) 2021-08-23 17:30:56 -04:00
img Update MIDAS-level -> metasimulation naming in docs (#822) 2021-08-23 17:30:56 -04:00
tools pdfs to images script 2018-05-19 19:09:37 +00:00
.gitignore Port to Python3 + Switch to GH-A CI (#878) 2022-01-20 11:03:37 -08:00
Building-a-FireSim-AFI.rst Cleanup docs 2020-02-25 11:49:56 -08:00
FireSim-Basics.rst [docs] Add Golden Gate to the terminology in FireSim Basics 2019-10-11 10:16:30 -04:00
Makefile Port to Python3 + Switch to GH-A CI (#878) 2022-01-20 11:03:37 -08:00
README.md bump docs requirements.txt to latest 2022-04-04 21:31:30 +00:00
conf.py [docs] Add a role to simplify generating GH file refs 2022-04-04 19:05:39 -07:00
index.rst Merge branch 'main' into use_conda 2022-04-06 15:48:40 +00:00
make.bat New squashed FireSim repo for open-sourcing 2018-05-13 19:40:34 +00:00
requirements.txt Merge branch 'main' into use_conda 2022-04-06 15:48:40 +00:00

README.md

Building Docs

sudo -E $CONDA_EXE install --file ./requirements.txt
make html

Look in the _build/html directory for output. You can also run

python3 -m http.server

To get a proper locally-hosted version.

If you want to generate a pdf version, you will additionally need:

wget http://mirror.ctan.org/systems/texlive/tlnet/install-tl-unx.tar.gz
tar -xvf install-tl-unx.tar.gz
cd install-tl*
sudo /bin/bash -l -c ./install-tl

Follow the prompts, add the suggested path to your .bashrc.