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.

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

docs: try to make window inline #241

Merged
merged 10 commits into from
Sep 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions docs/source/websim.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Live Caustics Playground

Here is a little online simulator run using caustics! It's slow because it's
running on a free server, but it's a good way to play with the simulator without
having to install anything.

Pro tip: check out the "Pixelated" source to lens any image you want!

<div style="display: flex; height: 500px;">
<iframe src="https://ciela-institute-caustics-webapp-guistreamlit-app-yanhhm.streamlit.app/?embed=true" style="flex-grow: 1; width: 100%;"></iframe>
</div>

If the window doesn't show up just follow this link:
[caustics-webapp](https://ciela-institute-caustics-webapp-guistreamlit-app-yanhhm.streamlit.app)

For frequent simulator users (e.g., if you plan on exploring the parameter space
of a lens), we recommend installing the simulator locally and running it in your
browser. Follow the steps below:

1. Install Caustics. Please follow the instructions on the
[install page](https://caustics.readthedocs.io/en/latest/install.html).
2. `pip install streamlit`
3. `git clone https://github.com/Ciela-Institute/caustics-webapp.git`
4. Move into the `caustics-webapp/gui/` directory and run the following command:
`streamlit run streamlit_app.py --server.enableXsrfProtection=false`

If you were successful in installing the simulator, Step 4 should automatically
open the simulator in your default browser.
17 changes: 0 additions & 17 deletions docs/source/websim.rst

This file was deleted.