Skip to content

NREL/tyche-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tyche Documentation

This repository will hold up-to-date compiled documentation for the Tyche (TechnologY Characterization and Evaluation) software. Open Tyche.pdf to begin.

Updating

To re-generate this documentation:

  • Clone this repository and tyche to your local machine.
  • Install a LaTeX distribution if you don't already have one. MiKTeX works and can be installed locally.
  • Open an Anaconda prompt, activate the tyche environment, and change the directory to the docs subdirectory within your local tyche repository directory.
  • Use sphinx to generate a .tex file in this repository directory:
sphinx-build -b latex path\to\tyche\repo path\to\tyche-docs\repo
  • Change the directory to your local tyche-docs repository directory.
  • Use the LaTeX distribution to generate the documentation PDF:
xelatex Tyche.tex
  • Use git to commit and push the updated documentation to this repository.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages