-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Conceptual guide almost finished. Now working on qucikstart and techn…
…ical_guide.md
- Loading branch information
Showing
5 changed files
with
184 additions
and
9 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
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
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 |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Quickstart | ||
This is a quickstart guide to get you up and running with the `random_events` library. | ||
|
||
## Installation | ||
|
||
To install the library, run the following command: | ||
|
||
[//]: # (```bash) | ||
|
||
[//]: # (pip install random_events) | ||
|
||
[//]: # (```) | ||
|
||
Next, import the necessary functionality: | ||
|
||
```{code-cell} ipython3 | ||
:tags: [] | ||
from random_events.variable import Symbolic, Continuous | ||
from random_events.product_algebra import SimpleEvent, Event | ||
from random_events.interval import SimpleInterval, Interval, closed, closed_open | ||
from random_events.set import SetElement, Set | ||
import plotly | ||
import plotly.graph_objects as go | ||
plotly.offline.init_notebook_mode() | ||
```` | ||
## Intervals | ||
Intervals are a fundamental concept in the `random_events` library. | ||
They are used to represent the range of possible values that a variable can take. | ||
There are two classes to interact with intervals: `SimpleInterval` and `Interval`. | ||
However, it is **strongly recommended** to use the `Interval` class, | ||
as it provides an API implementing all set operations. | ||
First, create two simple intervals: | ||
```{code-cell} ipython3 | ||
:tags: [] | ||
si1 = SimpleInterval(0, 1) | ||
si2 = SimpleInterval(0.5, 1.5) | ||
si1, si2 | ||
```` | ||
## Sets | ||
## Variables | ||
## Events |
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
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
# Technical Guide |