Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
companion_planting:development_log [2017/06/19 00:29] – kimparker | powerplant:development_log [2017/12/20 00:57] (current) – ↷ Page moved from companion_planting:powerplant:development_log to powerplant:development_log aimeejulia | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== Development Log ====== |
- | ===== Research ===== | + | |
- | [[https:// | + | |
- | [[https:// | + | ===== Model Decisions ===== |
- | [[http://organic.kysu.edu/CompanionSpacing.shtml|Companion Plant Spacing]] Research done by Kentucky State University on the spacing of intermixed companion plants in a hexagonal formation. The gist is that the spacing is a weighted average of the recommended spacing of the two crops based on the proportions of the crops. | + | * https://github.com/openfarmcc/Crops/issues/5 |
- | + | * https:// | |
- | [[http://organic.kysu.edu/BiointensiveMixtures.pdf|Paper by M.K. Bomford]] Further development on the KYSU research above. Has a few key conclusions, | + | * FarmOS |
- | * Results suggest that mixed planting can increase land-use efficiency of BIA systems under resource-limiting conditions. | + | |
- | * Cool-season crops should not be mixed with warm-season crops for synchronous growth in mixed plantings. | + | |
- | + | ||
- | [[https:// | + | |
- | + | ||
- | [[https://github.com/nosslin579/smigo|Another Crop Planner]] Also open-source, | + | |
- | + | ||
- | [[https:// | + | |
- | + | ||
- | The ticket #959 is the information base for the specification. Its written in a markup language not compatible with this wiki. Redmine is used to track the tasks around the development so it makes more sense to make this location the primary datasource. To make your contributions usable, write in the ticket or use redmine markup in the CODE text. Copy it over from the redmine everytime its updated there: | + | |
- | + | ||
- | < | + | |
- | + | ||
- | [[wiki|Back To Overview]] | + | |
- | + | ||
- | {{> | + | |
- | + | ||
- | h1. Software Requirement Specification | + | |
- | + | ||
- | for " | + | |
- | Version < | + | |
- | + | ||
- | h1. Introduction | + | |
- | + | ||
- | > TO DO: Identify the product whose software requirements are specified, including the revision or release number. Describe the scope of the product. | + | |
- | + | ||
- | h1. Users | + | |
- | + | ||
- | * Gardeners, including anyone who wants to plan a garden and is happy to use open source software. | + | |
- | + | ||
- | More detail below. | + | |
- | + | ||
- | h1. Goal | + | |
- | + | ||
- | Help with garden planning using companion plants to deter pests, improve and add valuable information about the harvest, variety and planning. | + | |
- | + | ||
- | Taking into account: | + | |
- | + | ||
- | * Soil type | + | |
- | * Climate | + | |
- | * Growth time | + | |
- | * Sun and water requirements | + | |
- | + | ||
- | h2. Product Scope | + | |
- | + | ||
- | > Provide a short description of the software being specified and its purpose, including relevant benefits, objectives and goals. | + | |
- | + | ||
- | h3. Software description | + | |
- | + | ||
- | * Convert data on crops into - SOMETHING - usable by anyone interested in gardening. | + | |
- | * Open-source | + | |
- | + | ||
- | > TODO: write more and better text | + | |
- | + | ||
- | h3. Objectives | + | |
- | + | ||
- | * Improve planning process for anyone who wants to use permaculture principles in their gardening. | + | |
- | * Save time during the planning process for anyone who wants to use permaculture principles in their gardening. | + | |
- | * Education of users | + | |
- | * Improve and collect data in open databases | + | |
- | * Increase harvest yield | + | |
- | * Connect with other open source projects for mutual benefit | + | |
- | + | ||
- | h1. Overall Description | + | |
- | + | ||
- | >TO DO: Describe the context and origin of the product being specified. Include a simple diagram that shows the major components of the overall system, subsystem interconnections, | + | |
- | + | ||
- | h2. Product Perspective | + | |
- | + | ||
- | > decide if this user description is relevant here, in our opinion the vision of the software should be written down. | + | |
- | + | ||
- | h3. Outcome | + | |
- | + | ||
- | A year of use of this software will result in: | + | |
- | + | ||
- | * Users adding to data from all over the world (different climates, soil types) | + | |
- | * Maybe make some money for affiliate links | + | |
- | * Users plan garden and fields with our software | + | |
- | * Enhance other open source projects with valuable information | + | |
- | + | ||
- | >TODO: more to be added here | + | |
- | + | ||
- | h2. Context | + | |
- | + | ||
- | The information that we provide is all out there, we want to provide a central source for all of it. Aid those gardening without experience and help make quick and precise descision for the more experienced gardener. | + | |
- | + | ||
- | h2. Origin | + | |
- | + | ||
- | Permaculture guidelines, gardening best practices. | + | |
- | + | ||
- | Permaculture ideals | + | |
- | + | ||
- | * Care for the earth | + | |
- | * Care for the people | + | |
- | * Fair share | + | |
- | + | ||
- | Open Source/ Open Data. | + | |
- | + | ||
- | h2. Product Functionality | + | |
- | + | ||
- | > 1 TO DO: Summarize the major functions that the product must perform or must let the user perform. | + | |
- | > 2 TO DO: Still sorting this | + | |
- | + | ||
- | h3. Must Have | + | |
- | + | ||
- | * Need a list of available plants | + | |
- | * Need to be able to see compatible/ | + | |
- | * Need to be able to filter by multiple plants | + | |
- | * Find optimal planting schedule for a set of plants | + | |
- | * Information accessible on timeline of different stages and locations of growth (i.e. when to grow in greenhouse and put them outside) | + | |
- | * Read more information on the plant we display | + | |
- | * Print what we harvest list | + | |
- | * Print Requirements for selected plants. | + | |
- | * List Plants that are only available in *filter* | + | |
- | * Add information on plants | + | |
- | ** only available in a certain timespan | + | |
- | ** compatible plants for selected beds | + | |
- | ** compatible plants for harvested beds | + | |
- | + | ||
- | h3. Must Have Process | + | |
- | + | ||
- | # List of plants I like (with autocomplete) | + | |
- | ## add from all plants | + | |
- | ## remove already added plants | + | |
- | ## add constraints | + | |
- | # compatibility chart | + | |
- | ## warnings on too many combinations (reason: size of beds, efficient seed usage) | + | |
- | ## best 5 group combination, | + | |
- | ## select favourite group | + | |
- | ## compatibility suggestions, | + | |
- | ## list plants compatible to this group | + | |
- | # schedule (status of garden) for a group | + | |
- | ## list plant plant/ | + | |
- | ## list plant fill bed times | + | |
- | ## define livecycle for plant (percent) | + | |
- | ## display suggestions for empty times (lettuce/ | + | |
- | ## define time the schedule displays (min: week, max: month) | + | |
- | ## create new compatibility chart for next period/ | + | |
- | # reports weekly what needs to be done with each plant | + | |
- | ## filter when nothing has to be done | + | |
- | # store the schedule for one ' | + | |
- | # load bed from url and display schedule for current date | + | |
- | # profile to store multiple beds | + | |
- | # erase bed history | + | |
- | # take user feedback | + | |
- | + | ||
- | h3. Should Have | + | |
- | + | ||
- | # Find optimal planting combinations for any number of plants per bed | + | |
- | ## Based on distance between plants | + | |
- | # List following plants for harvested beds | + | |
- | # Sharing/ | + | |
- | + | ||
- | h3. Cool to Have | + | |
- | + | ||
- | * Include types of beds required for a crop | + | |
- | * Get revenue from links for more information. | + | |
- | * Plant pictures | + | |
- | * Print Shopping List | + | |
- | + | ||
- | + | ||
- | >>? technical detail? ** Include: Soil conditions, grow time, climate, sun direction relative to each bed, labor required for each plant, sun+water required, best season/time to plant, care frequency, nitrogen/ consumption | + | |
- | + | ||
- | + | ||
- | * Have some visualization of garden beds with plants | + | |
- | * Draw in current crops | + | |
- | * Keep track of nitrogen fixers/ | + | |
- | + | ||
- | > TO DO: Still to decide in which section the attributes fit | + | |
- | + | ||
- | * Need to filter by attribute(s): | + | |
- | ** TODO(Soil conditions, grow time, climate, sun direction relative to each bed, labor required for each plant, sun+water required, best season/time to plant, care frequency) | + | |
- | + | ||
- | h3. 2. Provide a Data Flow Diagram of the system to show how these functions relate to each other. | + | |
- | + | ||
- | > TO DO: will create later | + | |
- | + | ||
- | h2. Users and Characteristics | + | |
- | + | ||
- | h3. Identify the various users that you anticipate will use this product. | + | |
- | + | ||
- | * Hobbyist - small home garden. 20 m2 | + | |
- | * Countryside garden - 250 - 1000 m2 | + | |
- | * Organic farmer - 1000 m2 + | + | |
- | * Consultant - all of the above | + | |
- | * Anyone who wants to plan a garden by using companion planting. | + | |
- | * People who want to use open source/ open data software. | + | |
- | + | ||
- | + | ||
- | h3. Describe the relevant and important characteristics of each user. | + | |
- | + | ||
- | * Hobbyist - Not too much labor is better; organic/ | + | |
- | * Countryside garden - Same as Hobbyist, also wants to be self-sufficient | + | |
- | * Organic farmer - Same as Hobbyist, also prioritizing lower labor. Intermixed plants means more labor. Technologically literate, want to use software to improve their yields | + | |
- | * Consultant - Provide advise to other hobbyists/ | + | |
- | + | ||
- | + | ||
- | h2. Operating Environment | + | |
- | + | ||
- | > Describe the environment in which the software will operate, including the hardware platform, operating system and versions, and any other software components or applications with which it must peacefully coexist. In this part, make sure to include a simple diagram that shows the major components of the overall system, subsystem interconnections, | + | |
- | + | ||
- | * Lower range laptop | + | |
- | * Windows 10, Chrome, use in office or garden | + | |
- | * Android x.x.x, Chrome, use in office or garden, but mainly garden | + | |
- | * With temporary internet connection | + | |
- | + | ||
- | h2. Design and Implementation Constraints | + | |
- | + | ||
- | > Describe any items or issues that will limit the options available to the developers. These might include: | + | |
- | > * hardware limitations (timing requirements, | + | |
- | > * interfaces to other applications | + | |
- | > * specific technologies | + | |
- | > * tools | + | |
- | > * databases to be used | + | |
- | > * language requirements | + | |
- | > * User Documentation | + | |
- | + | ||
- | * Want to use vanilla Javascript for front end and back end. | + | |
- | * Plain HTML, LESS for css | + | |
- | * Need to eventually be compatible with FarmOS. | + | |
- | * Need to eventually be compatible with Openfarm.cc. | + | |
- | * Want to be similar to FarmOS crop database structure. | + | |
- | * Text + photo editors. | + | |
- | * Want to MongoDB | + | |
- | * Express for route handling | + | |
- | + | ||
- | h2. User Documentation | + | |
- | + | ||
- | > TO DO: Describe what kind of manuals and what kind of help is needed for the software you will be developing. | + | |
- | List the user documentation components (such as user manuals, on-line help, and tutorials) that will be delivered along with the software.// | + | |
- | + | ||
- | Need to have user documentation. Usability will be severly limited without. Need to have in depth descriptions of how to input data, what screens should look like, how to interpret output. Need to document things before creating them. | + | |
- | + | ||
- | * User manual | + | |
- | * FAQ | + | |
- | * First time user prompts | + | |
- | * Community talking points | + | |
- | * Chat rooms (like FarmOS) | + | |
- | * Tutorials for most exemplary tasks | + | |
- | + | ||
- | h1. Specific Requirements | + | |
- | + | ||
- | h2. External Interface Requirements | + | |
- | + | ||
- | > TO DO: Describe user interfaces, different screen images, any GUI standards, standard buttons and functions (e.g., Cancel) that will be available to the user. Define error message display standards. | + | |
- | + | ||
- | *TODO: Warnings / Suggestions all over the place, define toast/ | + | |
- | + | ||
- | h3. Hardware Interfaces | + | |
- | + | ||
- | > Describe the logical and physical characteristics of each interface between the software product and the hardware components of the system. This may include, the supported device types, the nature of the data and control interactions between the software and the hardware. | + | |
- | + | ||
- | * 800x400 display | + | |
- | * 100kB/s | + | |
- | * 200mb memory on mobile | + | |
- | * 512mb memory on non-mobile | + | |
- | * 5mb local storage | + | |
- | + | ||
- | h3. Software Interfaces | + | |
- | + | ||
- | > TO DO: Describe: the connections between the product and other specific software components (name and version), | + | |
- | + | ||
- | * FarmOS | + | |
- | * Openfarm.cc | + | |
- | + | ||
- | > TO DO: Identify data items or messages coming into the system and going out and describe the purpose of each. | + | |
- | + | ||
- | * FarmOS specs go here | + | |
- | * openfarm.cc specs go here | + | |
- | + | ||
- | > TO DO: Describe the services needed. | + | |
- | + | ||
- | > TO DO: Identify data that will be shared across software components. | + | |
- | + | ||
- | * need to look at what FarmOS stores and what we store | + | |
- | | + | |
- | + | ||
- | + | ||
- | h3. Communications Interfaces | + | |
- | + | ||
- | TO DO: | + | |
- | + | ||
- | 1. Describethe requirements associated with any communications functions required by this product, including e-mail, web browser, network server communications protocols, electronic forms. | + | |
- | 2. Define any pertinent message formatting. | + | |
- | + | ||
- | h2. communication standards that will be used, such as FTP or HTTP. | + | |
- | + | ||
- | REST | + | |
- | + | ||
- | > TODO: Put API specs on wiki and link to it | + | |
- | + | ||
- | h4. communication security or encryption issues, data transfer rates, and synchronization mechanisms. | + | |
- | + | ||
- | * Profile could have sensitive info | + | |
- | * Even in case of (locally) illegal crops being grown, info cannot be accessible by anyone | + | |
- | * Yield is sensitive | + | |
- | * Complete transparency within network of gardeners, zero transparency outside | + | |
- | * low bandwidth because garden usually has bad reception (GPRS traffic) | + | |
- | * Sync profile data between local and server | + | |
- | + | ||
- | + | ||
- | h2. Behavior Requirements | + | |
- | + | ||
- | h3. Use Case View | + | |
- | + | ||
- | TO DO: Provide a use case diagram which will encapsulate the entire system and all possible actors. | + | |
- | + | ||
- | </ | + |