Table of Contents
Cropdusters project contains three main models with the following functionalities:
Additional infoNo additional info. |
All the requirements and dependandies are specified in the pyproject.toml, please consult that when setting up your envrionment to properly run this project.
The easiest way to install any package is by running:
pip install [package_name]
If any package needs to be updated, run:
pip update [package_name]
We reccomend use of the Cookiecutter template for new installations of the project. After installing Cookiecutter, all you need to do is to run the following command:
cookiecutter gh:wustl-data/cropdusters_PR2
You will get an interactive prompt where you'll specify relevant options for your project (or the default value will be used). NOTE you will require properly setup permissions for the wustl-data organization in order to install using cookiecutter. The number of dependancies has been kept light to ensure an easy installation using pip or the package manager of your choice is a simple task.
Please note that entered values are case-sensitive. Default values are provided as an example to help you figure out what should be entered.
On manual setup, you need to replace only values written in uppercase.
Name | Default value | Description |
---|---|---|
PROJECT_NAME | cropdusters | The project name |
REPO_SLUG | cropdusters_PR2 | URL slug within the wustl-data organization |
FULL_NAME | Jingyuan Zhu | Corrosponding maintainer |
FULL_NAME | Anton Young | Corrosponding maintainer |
FULL_NAME | Jack Weitzner | Corrosponding maintainer |
OPEN_SOURCE_LICENSE | MIT license | Copyright (c) 2023, WUSTL Data Wrangling |
See the open issues for a list of proposed features (and known issues).
- Top Feature Requests (Add your votes using the ๐ reaction)
- Top Bugs (Add your votes using the ๐ reaction)
- Questions
First off, thanks for taking the time to contribute! Contributions are what makes projects like this possible. Any contributions you make will benefit the family farms we are focused on helping and are greatly appreciated.
Please try to create bug reports that are:
- Reproducible. Include steps to reproduce the problem.
- Specific. Include as much detail as possible: which version, what environment, etc.
- Unique. Do not duplicate existing opened issues.
- Scoped to a Single Bug. One bug per report.
This project is licensed under the MIT license. Feel free to edit and distribute this template as you like.
See LICENSE for more information.
Thanks to everyone who contributed to this project including the origional maintainers:
Jack Weitzner (@JackWeitzner), Anton Young (@antonryoung02), and Jingyuan Zhu (@Jingyuan-zhu).
Special thanks also to @schlich who led the course under which this project was developed. Your time spent reviewing our issues and providing helpful pull requests has made this project possible.