Code Monkey home page Code Monkey logo

cropdusters's Introduction

Cropdusters


license

PRs welcome made with hearth by dec0dOS

Table of Contents

About

Cropdusters project contains three main models with the following functionalities:

  • Suggest ideal crop types based on location
  • Predict end of season yields
  • Calculate sale price based on historical data This is all provided as we work to provide a useful modeling solution for smallholder farms who do not have the means to access such envrionmental consulting as the big players and allow them to make the best choices for thier financies, their communities, and themsevles. This is a work in progress, please feel free to open a pull request adding functionality along the lines of what is described.
Additional info

No additional info.

Getting Started

Prerequisites

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]

Usage

Cookiecutter template

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.

Variables reference

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

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

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.

License

This project is licensed under the MIT license. Feel free to edit and distribute this template as you like.

See LICENSE for more information.

Acknowledgements

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.

cropdusters's People

Contributors

jingyuan-zhu avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.