-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
+ minor bug fix
- Loading branch information
Showing
22 changed files
with
5,984 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
venv/ | ||
venv/* | ||
|
||
figs/ | ||
figs/* | ||
|
||
eeg_data.pkl |
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,47 @@ | ||
# Reproducing results of the `sbijax` manuscript | ||
|
||
In order to reproduce the results of the paper, please follow the steps below. | ||
|
||
Install a new Python3.11 virtual environment and activate it using: | ||
|
||
```shell | ||
python3.11 -m venv venv | ||
source venv/bin/activate | ||
``` | ||
|
||
Install `sbijax` and all dependencies using: | ||
```shell | ||
pip install -r requirements.txt | ||
``` | ||
|
||
## Usage with Jupyter notebooks | ||
|
||
For each section that contains code and figures, we provide a separate Jupyter notebook. | ||
All notebooks contain the results and figures shown in the main manuscript. | ||
|
||
To run all experiments using Jupyter, first install a Jupyter kernel: | ||
```shell | ||
python -m ipykernel install --name sbi-dev --user | ||
``` | ||
|
||
Then call | ||
```shell | ||
cd experimental_code | ||
jupyter lab | ||
``` | ||
|
||
This opens Jupyter on your web browser. You can now run any of the three notebooks. | ||
|
||
## Usage with Python files | ||
|
||
For each section that contains code and figures, we also provide separate Python files. | ||
|
||
To execute each and reproduce the results of a section, call: | ||
```shell | ||
cd experimental_code/scripts | ||
python chp3-the_sbi_package.py | ||
python chp4-examples.py | ||
python chpx-appendix.py | ||
``` | ||
|
||
Calling a Python script creates files in a folder called `fig`. |
Oops, something went wrong.