These files provide examples of some of the things you can do with SimWrapper. Check out the full docs at https://simwrapper.github.io
Make a local clone of this repo on your computer.
Browse to https://simwrapper.github.io/site
If you're using Google Chrome or MS Edge, you can click "Add Folder" on the main SimWrapper page, browse to the
datafolder in your clone, and give Chrome read access to it.For Firefox/Safari, you need to install a little helper app that enables those browsers to view local files.
- Python 3.6+: run
pip install simwrapperto install the command-line tool - Then
simwrapper servewill run the python tool which serves files for you. - 'simwrapper serve' provides a tiny local file server on localhost:8080 that serves up files & folders in the directory in which it was started.
- Now you can go to https://simwrapper.github.io/site/local/ to see the data files.
- Note: this helper is only necessary for viewing local files on your computer: if you publish a SimWrapper site to the web, anyone will be able to access it, regardless of browser.
- Python 3.6+: run
You can host your project site easily on the web, using https://fly.io which has a nice free tier up to 5GB (check their pricing for details)
First time setup:
- Install
flyctltool from https://fly.io/docs/hands-on/installing/ - Run
flyctl auth signuponce to get a free account
Then:
- Copy your data files & folders into the
datafolder here (you can just use the example files as a test first, if you want! It's free) - run
flyctl launchand answer the prompts, noting the site name - Your site is now live at the https://your-site-name.fly.dev
Full documentation of SimWrapper is at https://simwrapper.github.io. Have fun!