Skip to content
This repository was archived by the owner on Jul 15, 2024. It is now read-only.

Commit 5fa6fc3

Browse files
committed
Update readme
1 parent 6d872f7 commit 5fa6fc3

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,28 @@
1-
# Ibis Examples
1+
# Ibis Example Notebooks
22

33
This repository contains runnable example notebooks for
4-
[Ibis](ibis-project.org/).
4+
[Ibis](ibis-project.org/). They are intended to be educational and give users
5+
examples of common Ibis workflows.
56

6-
They are intended to be run on [mybinder.org](https://mybinder.org) via the
7-
link below:
7+
The easiest way to run the notebooks is in the cloud by clicking the link
8+
below:
89

910
[![Binder](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ibis-project/ibis-examples/main)
11+
12+
## Contributing
13+
14+
Do you have an interesting example notebook that makes use of `ibis`? Please
15+
consider submitting it to this repository.
16+
17+
Note that examples should adhere to the following guidelines:
18+
19+
- Run top-to-bottom without error/intervention from the user
20+
21+
- Not require external data sources that are likely to disappear over time
22+
23+
- Not be resource intensive. Currently notebook sessions launched in
24+
[mybinder.org](https://mybinder.org) have access to 1-2 GiB of RAM. Your
25+
example must be able to run within these restrictions.
26+
27+
- Be *interesting*, *exemplary* of good `ibis` usage, and of *general
28+
relevance* to `ibis` users.

0 commit comments

Comments
 (0)