This repository was archived by the owner on Jul 15, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
23 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,28 @@ | ||
# Ibis Examples | ||
# Ibis Example Notebooks | ||
|
||
This repository contains runnable example notebooks for | ||
[Ibis](ibis-project.org/). | ||
[Ibis](ibis-project.org/). They are intended to be educational and give users | ||
examples of common Ibis workflows. | ||
|
||
They are intended to be run on [mybinder.org](https://mybinder.org) via the | ||
link below: | ||
The easiest way to run the notebooks is in the cloud by clicking the link | ||
below: | ||
|
||
[](https://mybinder.org/v2/gh/ibis-project/ibis-examples/main) | ||
|
||
## Contributing | ||
|
||
Do you have an interesting example notebook that makes use of `ibis`? Please | ||
consider submitting it to this repository. | ||
|
||
Note that examples should adhere to the following guidelines: | ||
|
||
- Run top-to-bottom without error/intervention from the user | ||
|
||
- Not require external data sources that are likely to disappear over time | ||
|
||
- Not be resource intensive. Currently notebook sessions launched in | ||
[mybinder.org](https://mybinder.org) have access to 1-2 GiB of RAM. Your | ||
example must be able to run within these restrictions. | ||
|
||
- Be *interesting*, *exemplary* of good `ibis` usage, and of *general | ||
relevance* to `ibis` users. |