Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating fastsim-2 readme to include instructions for downloading demo files #130

Merged
merged 2 commits into from
May 28, 2024
Merged

updating fastsim-2 readme to include instructions for downloading demo files #130

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2e0cdc
updating fastsim-2 readme to include instructions for downloading dem…
robinsteuteville May 27, 2024
81e78eb
updating wording
robinsteuteville May 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
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
Loading