Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
ycai
simbricks
Commits
d738dc2b
"driver/driver.cpp" did not exist on "7d8daba741da8eb01bc6dcae34953b8fb846ee13"
Commit
d738dc2b
authored
May 08, 2024
by
Jakob Görgen
Committed by
Antoine Kaufmann
May 09, 2024
Browse files
README: updated to mention simbricks-examples repo
parent
fd268425
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
20 additions
and
9 deletions
+20
-9
README.md
README.md
+20
-9
No files found.
README.md
View file @
d738dc2b
...
...
@@ -49,8 +49,6 @@ details.**
### Using Pre-Built Docker Images
**This is the quickest way to get started using SimBricks.**
We provide pre-built Docker images on
[
Docker Hub
](
https://hub.docker.com/u/simbricks
)
. These images allow you to
start using SimBricks without building it yourself or installing any
...
...
@@ -92,15 +90,28 @@ root@fa76605e3628:/simbricks/experiments# simbricks-run --verbose --force pyexps
...
```
###
Experimental: Interactive SimBricks Jupyter Lab
s
###
SimBricks Usage Example
s
**This is
still a work in progres
s.**
**This is
the quickest way to get started using SimBrick
s.**
We are working on a more interactive introduction to SimBricks through Jupyter
Labs in
[
this repository
](
https://github.com/simbricks/labs
)
. These also simply
require starting a pre-built docker container and then connecting to it from
your browser. After this you can follow the interactive steps to run SimBricks
simulation directly from your browser.
We provide a
[
repository
](
https://github.com/simbricks/simbricks-examples
)
that contains a series of examples including an easy-to-use and more interactive
introduction to SimBricks through a Jupyter Notebook showing first steps on how to orchestrate
and run simulations using SimBricks. The repository is set up for usage
with
[
GitHub codespaces
](
https://github.com/codespaces/new/simbricks/simbricks-examples/?quickstart=1
)
which in conjunction with the Jupyter Notebook provide a very easy to use step-by-step introduction
to SimBricks.
For more advanced use-cases the repository provides an example for users
on how one can provide custom disk images to simulated SimBricks hosts for non-trivial
use-cases, and a project on hardware acceleration composed of several milestones
guiding users through a complete SimBricks based development flow.
The repository is set up with a dev container configuration that makes running the
examples a breeze. For quick tests you can just open the repo in CodeSpaces. The
easiest way to use this locally is with vscode and its Dev Containers Extension. You can
find more details on how to use the provided experiments in the repositories
[
README
](
https://github.com/simbricks/simbricks-examples/blob/main/README.md
)
.
### Building Docker Images
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment