Skip to main content

Collaborate

⬆️ Pull Request Guide

How to contribute to the Octopus project

The following is a basic guide for creating pull requests for submitting to any of the Octopus repositories such as this Documentation or Octopus Arduino Library used to deploy the Octopus.

tip

For a visual reference to the same process, please see Nemgrea’s video guide.

  1. Make sure you have a GitHub user, if not, create one.
  2. Browse to the Octopus Github repo, either Octopus Documentation or Octopus Library.
  3. On the top right, click on ‘Fork’.
  4. It will process for a few seconds, then return back with a fork of the selected repository. The owner will no longer be ‘Senseable City Lab’, but the user who forked the repository.
  5. Make the desired changes to the local/forked repository. This can be done from the web UI, the command line, or other software with git.
  6. Create a commit with your changes. This will add the changed files to the request.
  7. Return back to the main Octopus repo by clicking the link next to “forked from SenseableCityLab/”
  8. Select Pull Requests and click the New Pull Request button.
  9. Select Compare Across Forks and select your repository.
  10. Give a title for your pull request and fill out the form.
  11. Click Create Pull Request. This will submit your request, and will manually be reviewed by developers at Senseable City Lab.

🔬 Research

Papers TBA

🌐 Other Resources

info

This document will be extended based on challenges and issues encountered by the Octopus community.

Arduino Forum​

If you want to explore other projects made with Arduino, we encourage you to have a look at the official Arduino Forum. The Arduino Forum is an online community platform where Arduino enthusiasts, hobbyists, and professionals share knowledge, discuss projects, and solve problems related to Arduino hardware and software. It serves as a valuable resource for users of all skill levels to learn about Arduino programming, connect with others, and explore a wide range of topics from basic electronics to complex systems integration.

Link: https://forum.arduino.cc/

Data analysis software​

For the use cases provided, the guide shows how to analyze the collected data by using Google Colaboratory. However, there are other tools to use to analyze the environmental data that can be used:

LinkComment
JupyterLabJupyterLab is an open-source, web-based interactive development environment for Jupyter notebooks, code, and data, providing a flexible and extensible architecture that supports data science workflows.
Kaggle KernelsKaggle Kernels is an integrated online platform that offers a coding environment similar to Jupyter notebooks, enabling users to write, run, and share code in a browser, primarily for machine learning and data analysis competitions hosted on Kaggle.
Microsoft Azure NotebooksMicrosoft Azure Notebooks is a free hosted service that provides Jupyter notebooks as part of Azure's cloud services to facilitate the sharing, collaboration, and publication of Python, R, and F# code for educational, research, and data science purposes.
DatabricksProvides a unified analytics platform powered by Apache Spark that facilitates collaboration between data scientists and engineers. It includes support for collaborative notebooks, data engineering tools, and machine learning capabilities.