Contribute

If you wish to contribute to Ollin’s project please do so! Just send a pull request in GitHub.

Contribution can be done in different fronts. In what follows we specify guidelines and procedures to contribute to Ollin for each type of contribution.

General Contribution Procedure

To contribute to Ollin, please fork the repository in GitHub, modify your fork and send a pull request. Additionally you can send an email to any of the maintainers with your contribution suggestions and code, although we generally prefer using the GitHub channel. Check this guide on how to make pull requests.

Model Contribution

With Ollin, we wish to provide a unified package and platform for analysis of motion and its relations to occupancy and home range. To this end we designed Ollin to make it relatively easy to contribute to an ever growing library of movement and estimation models. If you wish to to add you models to Ollin, please select the corresponding section.

• Add new Movement Models
  • Make the code
  • Efficiency Considerations
  • Calibration
  • Add file to models library
• Add new Estimation Model
  • Make the code
  • Select the correct return class
  • Write a statistical model with Stan
  • Add file to estimation library

Although code contribution requires some knowledge of python, we encourage those without the technical background to reach out to the maintainers with your ideas for new models.

Documentation Contribution

The documentation for Ollin is in its infancy and we wish to keep improving it. You can help us modifying the docstrings in the code base, or editing the documentation files.

The documentation files are contained in the docs/ directory of the code base. They are written in reStructuredText and are built with sphinx.

For docstrings we follow the numpydoc style, so please check this guide on writing documentation.

Feature suggestion

To suggest new features please open an issue in the github repository or send a message to any of the maintainers.

Bug Reports

If you’ve found a bug, please let us know! Before sending a report please check GitHub issues to see if your bug hasn’t been filed before. If no duplication is in sight, please open a new issue in GitHub or send a message to one of the maintainers.

Mantainers

Santiago Martínez:  santiago.mbal@gmail.com Everardo Robredo:  everardo.robredo@gmail.com