Smart Citizen Data
Welcome to SmartCitizen Data. This is a data analysis framework for working with sensor data in different ways:
- Interacting with several sensors APIs
- Clean data, export and calculate metrics
- Model sensor data and calibrate sensors
- Generate data visualisations - matplotlib,
plotlyor uplot - Generate analysis reports in html or pdf and upload them to Zenodo
Installation
You can check it out in the Python 3.* (tested between 3.9 and 3.11).
You can just run:
pip install scdata
Plots (device.ts_plot(), maps, panels...) need the plotting libraries, an optional extra. Without them scdata loads and processes data, and plotting raises an error that says how to install them:
pip install "scdata[plot]"
Work on the source code
Simply clone the repository with:
git clone https://github.com/fablabbcn/smartcitizen-data.git
cd smartcitizen-data
Install scdata package with requirements:
python setup.py install
Or if you want to edit:
pip install --editable ".[dev]"
Tokens and config
A configuration file is available at ~/.config/scdata/config.yaml, which contains a set of configurable variables to allow or not the local storage of relevant data in the data folder, normally in ~/.cache/scdata:
data:
cached_data_margin: 2
load_cached_api: true
reload_metadata: true
store_cached_api: true
paths:
config: /Users/username/.config/scdata
data: /Users/username/.cache/scdata
export: /Users/username/.cache/scdata/export
interim: /Users/username/.cache/scdata/interim
inventory: ''
models: /Users/username/.cache/scdata/models
processed: /Users/username/.cache/scdata/processed
raw: /Users/username/.cache/scdata/raw
reports: /Users/username/.cache/scdata/reports
uploads: /Users/username/.cache/scdata/uploads
zenodo_real_base_url: https://zenodo.org
zenodo_sandbox_base_url: http://sandbox.zenodo.org
Also, .env files will be picked from ~/.cache/scdata. An env.example is provided. If you want to upload data to Zenodo, you will need to fill set an environment variable called ZENODO_TOKEN in your environment. The .env file is not mandatory for scdata to work. It only serves for authentication if you want to POST or GET data without throttling. You can still do GET requests but they will be throttled if not authenticated/authorized by the platform. See user roles for more info.
Using with jupyter lab (optional)
It can also be used with jupyter lab or jupyter. For this install juypterlab.
Contribute
Issues and PR more than welcome!
Funding
This work has received funding from the European Union's Horizon 2020 research and innovation program under the grant agreement No. 689954
1 maintainer
Metadata
1 maintainer
Release files for scdata 1.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| scdata-1.6.0.tar.gz | 337.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| scdata-1.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 702.7 kB
Release files / scdata-1.6.0.tar.gz
| Download URL | scdata-1.6.0.tar.gz |
|---|---|
| Size | 337.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
de4183b54d6caa8712f19ca0b5e5db88ba5d4964bf8d2482f47f39a9bc3d4676
|
|
BLAKE2b-256 checksum How to use checksums |
06cb86ccfa896fdf308366be570c3a4a67a2b38d20d2d0256b18534873f98ee9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / scdata-1.6.0-py3-none-any.whl
| Download URL | scdata-1.6.0-py3-none-any.whl |
|---|---|
| Size | 364.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
874aa77d28696ec1e141e947ae6b4755799f7a8f9a7b3bf4094457032eb5f779
|
|
BLAKE2b-256 checksum How to use checksums |
4d6c807a2cb2f05c33e28d95c729ebf4ea63014fafab27ebf45fbfcad0d0ac24
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
