Skip to content

Commit

Permalink
edited readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
Simone Mora committed Mar 14, 2023
1 parent 98f1e25 commit 4109d1d
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 24 deletions.
11 changes: 1 addition & 10 deletions Explore/Calibration Handbook/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1 @@
### Open-Source City Scanner Manual

The [City Scanner project](https://senseable.mit.edu/flatburn/) initiated by the [Senseable City Lab](https://senseable.mit.edu/) at MIT is a pioneer in mobile environment monitoring. It aims at developing a sensing platform to enable large scale environmental sensing tasks using existing urban fleets as sensing nodes. In general, City Scanner adopts a low-cost, modular design with [internet-of-things (IoT)](https://en.wikipedia.org/wiki/Internet_of_things) capabilities. However, Low-cost sensors suffer from constant data quality and stability issues. It is of utmost importance to perform proper data calibration and validation before making any conclusions or decisions based on the data.

### **Sensing modules on a City Scanner**
<img src="https://github.com/MIT-Senseable-City-Lab/OSCS/blob/main/flatburn-images/flatburn%20configuration.jpeg" width="800px">

We illustrate City Scanner version **Flatburn**

In this folder, we present an open source [calibration manual](https://github.com/MIT-Senseable-City-Lab/OSCS/blob/main/Explore/Calibration%20Handbook/Calibration%20Handbook.pdf) to best assist our users in low-cost air sensor calibration, especially the use of City Scanner. We also provide [calibration codes](https://github.com/MIT-Senseable-City-Lab/OSCS/tree/main/Explore/Calibration%20Handbook/Calibration%20Code) that we used to demonstrate a standardized calibration process.
In this folder, we present an open source [calibration manual](Explore/Calibration%20Handbook/Calibration%20Handbook.pdf) to best assist our users in low-cost air sensor calibration, especially the use of City Scanner. We also provide [calibration codes](Explore/Calibration%20Handbook/Calibration%20Code) that we used to demonstrate a standardized calibration process.
8 changes: 4 additions & 4 deletions Learn/Coding Exercise/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
This folder contains a coding activity written in Python to introduce users to air quality and environmental sensing methods
by working with CityScanner Data, exploring time series analysis, geospatial analysis, and pollution hotspot analysis.
There are 2 versions:
One is a .py file containing python code and some descriptive text, which can be run in an environment of your choosing.
The other is a .ipynb file intended to be run on the Google CoLab platform.
- One is a `.ipynb` file containing python code and some descriptive text, which can be run in an environment of your choosing.
- The other is a `.ipynb` file intended to be run on the [Google CoLab](https://colab.research.google.com/) platform.

The notebooks provide sample code to run with New York City Deployment data, which can be edited to use different data files.
The notebooks provide sample code to run with New York City Deployment data, which can be edited to use different data files we provide in [explore/datasets](Explore/Datasets).

Please refer to the facilitator handbook in the Facilitator Handbook folder for further instructions.
Please refer to the [facilitator handbook](Learn/Facilitator%20Handbook) for further instructions.
11 changes: 4 additions & 7 deletions Learn/Facilitator Handbook/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
This folder contains support files for the python coding activity, aiming to provide users with background information
and context on mobile air quality monitoring and environmental sensing, as well as teaching coding skills and analysis
This folder contains support files for the python coding activity, aiming to provide users with background information and context on mobile air quality monitoring and environmental sensing, as well as teaching coding skills and analysis
techniques, including:

- Using popular Python libraries such as Pandas to interact with data
- Creating time series graphs of measurements of environmental phenomena
- Creating python-based web maps using the Python Leaflet.js library
- Creating python-based web maps using the Python [Leaflet.js](https://pypi.org/project/js.leaflet/) library

And more. There are 3 files in this directory - 2 facilitator guides and workshop slides. The facilitator guides are meant
to support an individual or teaching team in combining these resources to deliver during a class or workshop. There is one version for a Python
notebook that can be run in an environment of your choice, and one version to aid the facilitation of a Google CoLab notebook. The workshop slides
are an educational presentation on the background of environmental sensing, mobile air quality monitoring, and CityScanner.
And more. There are 3 files in this directory - 2 facilitator guides and workshop slides. The facilitator guides are meant to support an individual or teaching team in combining these resources to deliver during a class or workshop. There is one version for a Python notebook that can be run in an environment of your choice, and one version to aid the facilitation of a Google CoLab notebook. The workshop slides
are an educational presentation on the background of environmental sensing, mobile air quality monitoring, and the CityScanner platform.
4 changes: 2 additions & 2 deletions Learn/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
This folder includes:
- Jypiter Notebooks to perform air quality analysis
- Facilitator guide to arrange a coding workshop
- [Jypiter](https://jupyter.org/) [Notebooks](Learn/Coding%20Exercise) to perform air quality analysis
- [Facilitator guide](Learn/Facilitator%20Handbook) to arrange a coding workshop
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This repository contains all information to [build](build) your own Flatburn, [e

## Build
- [/hardware](Build/Hardware)
- [fabrication files](Build/Hardware%20enclosure) for Flatburn mechanical parts, including files for [3D printing](Build/Hardware/Hardware%20enclosure/To%20Print), [laser cutting](Build/Hardware/Hardware%20enclosure/To%20lasercut), and a [CAD model](Build/Hardware/Hardware%20enclosure/Flatburn_assembly.step) of the full assembly. A bill of materials listing all the required [mechanical components](https://docs.google.com/spreadsheets/d/1oa0ZC6CXszNmvcmob7ju2rJUDLLGSCP4pCBNqtu63Sk/edit?usp=sharing) is also included.
- [fabrication files](Build/Hardware/Hardware%20enclosure) for Flatburn mechanical parts, including files for [3D printing](Build/Hardware/Hardware%20enclosure/To%20Print), [laser cutting](Build/Hardware/Hardware%20enclosure/To%20lasercut), and a [CAD model](Build/Hardware/Hardware%20enclosure/Flatburn_assembly.step) of the full assembly. A bill of materials listing all the required [mechanical components](https://docs.google.com/spreadsheets/d/1oa0ZC6CXszNmvcmob7ju2rJUDLLGSCP4pCBNqtu63Sk/edit?usp=sharing) is also included.
- [hardware schematics](Build/Hardware/Hardware%20schematics) contains `.brb` files for the main-board and the sensor-board which can be viewed using the [Cadence](https://www.cadence.com/en_US/home/tools/pcb-design-and-analysis/allegro-downloads-start.html) free viewer, schematics of the PCB in `.pdf` format, and a [bill of materials](https://docs.google.com/spreadsheets/d/1-fR-0hTxHKbjaRf8DbH62WgUFVeNE4eUEsaAd-YdDYg/edit?usp=sharing) for the electronics components.
- [/firmware](Build/Firmware): The Flatburn main firmware code base, developed using [Particle.io](https://www.particle.io/workbench/) workbench.
- [/fabrication handbook](Build/Handbook): The assembly guide with detailed instructions on how to build flatburn.
Expand Down

0 comments on commit 4109d1d

Please sign in to comment.