Skip to content

jotpio/behavior_HF

Repository files navigation


Logo

RoboFish at HF

Code base of the RoboFish exhibit at Humboldt Forum

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This project is part of my master's thesis "Exploration of human leading behavior using a controlled biomimetic robot in a simulated fish tank". This repository contains the fish simulation and robot control. The simulation is based on the behavior model presented by Couzin et al. DOI:10.1006/jtbi.2002.3065

(back to top)

Built With

  • forthebadge made-with-python
  • Made withJupyter

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • install Python 3.9.5
  • install git

Installation

  1. Clone the repo
    git clone https://github.com/jotpio/behavior_HF.git
  2. Install pip packages using setup.py
    python setup.py install 

(back to top)

Usage

The main_challenge_simulation.py simulates the challenge in the Humboldt Forum. Use it if you intend to run it locally as it does not connect to the other software components. Run the it by executing:

python main_challenge_simulation.py

The main_simulation.py is the startup for the simulation in the Humboldt Forum exhibit. It connects to the other software components. Run the it by executing:

python main_simulation.py

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Shield: CC BY 4.0

This work is licensed under a Creative Commons Attribution 4.0 International License.

CC BY 4.0

See LICENSE for more information.

(back to top)

Contact

Jonas Piotrowski - marc.jonas.piotrowski@gmail.com

Project Link: https://github.com/jotpio/behavior_HF

(back to top)

Acknowledgments

(back to top)

forthebadge cc-by licensebuttons by

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages