Skip to content
This repository has been archived by the owner on Dec 15, 2020. It is now read-only.

Latest commit

 

History

History
67 lines (41 loc) · 3.86 KB

README.md

File metadata and controls

67 lines (41 loc) · 3.86 KB

Repo deprecated, please see Arduino Science Journal for the most recent version 🔬🧪 as well as the official blog post about the graduation of the project.

Science Journal Logo

Twitter: @GScienceJournal License

Science Journal for iOS allows you to gather data from the world around you. It uses sensors to measure your environment, like light and sound, so you can graph your data, record your experiments, and organize your questions and ideas. It's the lab notebook you always have with you.

iOS screenshot showing experiments list.iOS screenshot showing `Iodine Clock` experiment.iOS screenshot showing `Iodine Clock` recording showing brightness sensor with various values.iOS screenshot showing `Iodine Clock` recording with notes alongside brightness sensor with various values.

Features

  • Visualize and graph data from a variety of sources including your device's built-in sensor 📱
  • Connect to external sensors over BLE ↭🔌
  • Annotate observations with pictures 🏔 and notes 📝

More

Science Journal is brought to you by Making & Science, an initiative by Google.

Open Science Journal is not an official Google product.


Required dependencies

First, you'll need a Mac. We don't support building the iOS app on anything else.

Second, you'll need the latest version of Xcode installed.

Third, we use a few open source frameworks to build this app, so you'll need to install CocoaPods as your package manager in order to get what you need to build.

Fourth, we use protobuf. You'll need to install that too. We use Homebrew to install it.

Here are the steps to set up your environment:

  1. Install Xcode.
  2. Install CocoaPods by running sudo gem install cocoapods from your terminal.
  3. Install Homebrew by following the instructions on the Homebrew website.
  4. Install protobuf by running brew install protobuf@3.6; brew link protobuf@3.6 -f from your terminal.

Building and running

Before you jump into coding, you'll need to run pod install from the root of this project (the folder that contains has the Podfile file)

Then you can open ScienceJournal.xcworkspace

Note: there is a ScienceJournal.xcodeproj file, but since we use CocoaPods, you shouldn't use that project file. If you do, nothing will work 😭

Contribute to Science Journal iOS

Check out CONTRIBUTING.md for more information on how to help with Science Journal iOS.

Code of Conduct

Help us keep Science Journal open and inclusive. Please read and follow our Code of Conduct.

License

This project is licensed under the terms of the Apache 2.0 license. See the LICENSE file.