added a general project introduction

This commit is contained in:
Sebastian Wendel 2022-12-21 10:31:58 +01:00
parent a478a311dd
commit ba03f787ba
No known key found for this signature in database
GPG key ID: 1422B7DF78144640

View file

@ -1,47 +1,48 @@
<!-- <!--
SPDX-License-Identifier: CC-BY-SA-4.0 SPDX-License-Identifier: CC-BY-SA-4.0
--> -->
# Introduction
# Welcome to the PlanktoScope build and use documentation ## The PlanktoScope Project
![PlanktoScope](../images/readme/planktoscope_cad.webp) The [PlanktoScope is an open source hardware microscope](https://www.planktoscope.org/) designed specifically for the analysis of plankton, which are small aquatic organisms that play a vital role in the global ecosystem. It is a portable and affordable microscope that can be used to study and identify different types of plankton, including diatoms, copepods, and other tiny organisms that are critical to the health of our oceans.
You can find here more information about how to build your own PlanktoScope. One of the unique features of the PlanktoScope is its use of open source hardware, which means that the design plans and software code are freely available for anyone to access and modify. This allows users to customize the microscope to meet their specific needs, and to contribute their own modifications and improvements to the design.
## Setup The PlanktoScope is also designed to be easy to use, with a simple interface and straightforward controls. It includes a high-resolution camera and LED lighting, which allows users to capture clear and detailed images of the plankton they are studying.
- [How to setup your PlanktoScope the easy way](../software/easy_install.md) Overall, the PlanktoScope is a powerful tool for anyone interested in studying plankton or learning more about the intricate ecosystems of our oceans. It is a valuable resource for scientists, educators, and anyone interested in exploring the microscopic world of plankton.
- [How to setup your PlanktoScope the hard way (also known as the Expert's path)](../software/expert_setup.md)
- [Some information about how to setup a remote access](../usage/remote_access.md)
## Build your machine ## The importance of Open source hardware
- [Assembly Guide](../hardware/assembly_guide.md) <!-- <a href="https://www.oshwa.org/" rel="oshwa">![open-source-hardware](../images/logos/open-source-hardware.svg)</a> -->
## Usage ![open-source-hardware](../images/logos/open-source-hardware.svg){ align=right width="200"}
- [Information about collection devices](../hardware/collection_devices.md) [Open source hardware (OSH)](https://en.wikipedia.org/wiki/Open-source_hardware) refers to physical objects or devices that are designed and produced using open source principles. These principles include the sharing of information and resources, collaboration, and transparency, and they are intended to encourage the development and use of hardware that is accessible, customizable, and adaptable.
## Under the hood There are several reasons why open source hardware is important:
- [Software architecture](../contribute/software_architecture.md) 1. Accessibility: Open source hardware is typically available for anyone to use, modify, and distribute, which makes it more accessible than proprietary hardware. This can be especially beneficial for individuals, organizations, and communities that may not have the resources or expertise to develop their own hardware solutions.
- [MQTT Messages](../usage/mqtt_messages.md)
- [Create Master SD Card or backup your PlanktoScope](../software/create_sd.md)
- How does the segmentation works (soon)
## Changelog 2. Customization: Open source hardware can be customized to meet the specific needs and requirements of different users. This can be done through modifications to the design or the inclusion of additional components or features.
- [Changelog](../changelog.md) 3. Collaboration: Open source hardware encourages collaboration and the sharing of ideas and resources among developers and users. This can lead to the development of innovative and high-quality hardware solutions that may not have been possible through traditional proprietary models.
## Contribute 4. Transparency: Open source hardware promotes transparency by making the design and production processes open and accessible to all. This allows users to understand how the hardware works and to identify and address any potential issues or concerns.
- [Find out how to contribute to this documentation and help edit it](../contribute/writing_documentation.md) 5. Sustainability: Open source hardware can contribute to sustainability by promoting the reuse and repurposing of hardware and reducing the need for new hardware to be manufactured.
- [Contribute to the code, here is the getting started](../contribute/software_development.md)
## License of our work Overall, open source hardware is an important concept that promotes accessibility, customization, collaboration, transparency, and sustainability. It has the potential to bring significant benefits to individuals, organizations, and communities around the world.
- [More information about the licenses that we use](../license.md) ## The importance of Citizen science
## Design History Citizen science is a type of research in which the public can actively participate and contribute to the scientific process. It is an important and growing field that involves the participation of people from all walks of life, including non-scientists, in scientific research projects.
## Architecture One of the key benefits of citizen science is that it allows for the collection of data on a larger scale than would be possible with traditional scientific methods. This is particularly important in fields such as ecology, where data on the distribution and behavior of species can be collected over large geographic areas and over long periods of time. By involving the public in data collection, citizen science projects can generate large amounts of data that can be used to address important scientific questions and inform policy decisions.
Citizen science also has the potential to increase public understanding of science and to engage people in the scientific process. By participating in citizen science projects, people can learn about the scientific method, gain a deeper understanding of the natural world, and develop a sense of ownership and stewardship over the environment.
In addition, citizen science can help to build bridges between the scientific community and the general public, promoting collaboration and dialogue between the two groups. This can lead to a greater appreciation of the value of scientific research and a greater understanding of the role that science plays in society.
Overall, citizen science is an important tool for advancing scientific knowledge and understanding, and for engaging the public in the scientific process.