Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bessman/pslab-notebooks
Jupyter notebooks containing tutorials, examples, and exercises for the Pocket Science Lab
https://github.com/bessman/pslab-notebooks
Last synced: 12 days ago
JSON representation
Jupyter notebooks containing tutorials, examples, and exercises for the Pocket Science Lab
- Host: GitHub
- URL: https://github.com/bessman/pslab-notebooks
- Owner: bessman
- License: mit
- Created: 2023-12-22T22:22:08.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-29T18:51:40.000Z (about 1 year ago)
- Last Synced: 2024-11-07T10:13:42.316Z (2 months ago)
- Language: Jupyter Notebook
- Size: 499 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PSLab Notebooks
This repository (https://github.com/bessman/pslab-notebooks) contains a series of tutorials and exercises for the [Pocket Science Lab](https://pslab.io) (PSLab) [Python library](https://github.com/fossasia/pslab-python).
## Requirements
Python 3.8+ with pip.
## Installing `pslab`
Recommended way to install the `pslab` package:
- Create a virtual environment called 'pslab': Run `python -m venv pslab` on the command line.
- Activate the virtual environment.
- On Linux, run `source ./pslab/bin/activate`.
- On Windows, run `.\pslab\Scripts\activate.bat`
- Install the dependencies: Run `pip install pslab notebook matplotlib`
Once installed, connect the PSLab board and verify that you can connect to it by running `pslab collect -c 1 -d 0.00001 oscilloscope`. This will sample the voltage on the PSLab's CH1 pin for 10 µs. The output should look something like:
```
Timestamp,CH1
0.0,0.016129032258064058
0.5,0.016129032258064058
1.0,0.016129032258064058
1.5,0.016129032258064058
2.0,0.016129032258064058
2.5,0.016129032258064058
3.0,0.016129032258064058
3.5,0.016129032258064058
4.0,0.016129032258064058
4.5,0.016129032258064058
5.0,0.016129032258064058
5.5,0.016129032258064058
6.0,0.016129032258064058
6.5,0.016129032258064058
7.0,0.016129032258064058
7.5,0.016129032258064058
8.0,0.016129032258064058
8.5,0.016129032258064058
9.0,0.016129032258064058
9.5,0.016129032258064058
```
If you get an error saying `serial.serialutil.SerialException: Device not found.`, try another USB-cable.
If you are using Linux and get an error message saying you do not have permission to access the serial port, run `pslab install` as root. This will add a udev rule allowing regular users to access the PSLab. You may need to trigger udev to reload its ruleset before this takes effect. Consult your distro's documentation for instructions on how to reload udev.
Alternativelly, you can skip the udev rule and instead become a member of the group to which the /dev/tty* device files belong to. On Debian based distros this group is called 'dialout', on Arch based distros it is called 'uucp'. It may be called something else on other distros. Again, consult your distro's documentation for how to become a member of a group.
Once this installation is complete, launch Jupyter Notebooks by running `jupyter notebook`.
## Get the Tutorial Notebooks
If you are familiar with `git` you can clone this repo: `git clone https://github.com/bessman/pslab-notebooks`.
Otherwise you can go into the 'Getting Started' directory and download the notebooks manually.
Then, navigate to the location where you downloaded them with the Jupyter Notebook file browser and run them!