Skip to content

Commit

Permalink
Merge pull request #130 from NREL/add-demo-to-readme-fsim2
Browse files Browse the repository at this point in the history
updating fastsim-2 readme to include instructions for downloading demo files
  • Loading branch information
calbaker authored May 28, 2024
2 parents c6c7ded + 81e78eb commit 1745d5a
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,12 @@ Developers might want to install the code in place so that FASTSim files can be

## Usage

To see and run examples, navigate to `./python/fastsim/demos` and run the various *demo.py files to see fastsim use cases. There are other examples in fastsim/tests.
To see and run examples, download the FASTSim demo files using the following code (with your Python environment activated and FASTSim installed):
```python
from fastsim import utils
utils.copy_demo_files()
```
This code downloads demo files into a specified local directory (if no directory is specified, it will create a `\demos` folder in the current working directory). WARNING: If you download the demo files to a location where files of the same name already exist, the original files will be overwritten.

## Adding FASTSim as a Dependency in Rust

Expand Down

0 comments on commit 1745d5a

Please sign in to comment.