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

Add something like "Run your first simulation" to docs #79

Open
pmocz opened this issue Jan 8, 2025 · 0 comments
Open

Add something like "Run your first simulation" to docs #79

pmocz opened this issue Jan 8, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@pmocz
Copy link

pmocz commented Jan 8, 2025

Really cool, performance-portable code with unique physics features! I'm excited to see it grow :)

I'd find it very helpful to have a "Run your first simulation" page under "Getting started" that rapidly goes through an example of running your first simulation (e.g. just locally on your laptop) and making a pretty picture -- something like the 2 stream instability or weibel -- preferably that takes just a few minutes to run. A lightening recipe without all the details. Sorry if this is already in the docs and I missed it!

e.g.

blah blah blah

git clone --recursive git@github.com:entity-toolkit/entity.git

blah blah

cmake -B build -D pgen=srpic/weibel -D output=ON

blah blah

cmake --build build -j 8

blah blah

build/src/entity.xc -input setups/srpic/weibel/weibel.toml 

...

@haykh haykh added the enhancement New feature or request label Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants