@@ -12,32 +12,21 @@ repository will be automatically deleted by the end of the season.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might
be unfamiliar with (for example your team wiki). A list of Features or a Background subsection can also be added here.
If there are alternatives to your project, this is a good place to list differentiating factors.
Our team has developed a software that can perform univariate output BP neural network prediction. This software we developed using the Guide function that comes with Matlab. The user only needs to import the training set, the test set, the dataset to be predicted and then simply adjust the parameters related to the neural network on the software, such as the number of nodes, the learning rate, the error requirement, the neural network training algorithm and so on. After the user has trained the neural network, our software plots the fit curve and performs a goodness-of-fit and error calculation. The user can also export the trained network as a .mat file for subsequent use of the neural network on Matlab. During the development of the software, we found that the Guide function will be gradually replaced in versions of Matlab after R2021. For this reason, and in order to increase the universality of our software, we have redeveloped the software using the App Designer function that comes with the newer version of Matlab. There are no major differences between the two versions in terms of how to use the software.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew.
However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing
specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a
specific context like a particular programming language version or operating system or has dependencies that have to be
installed manually, also add a Requirements subsection.
Please note that this software is based on Matlab's own Guide function and App Designer function, so this software can only be run in Matlab's compiled environment. After downloading this software, users can simply drag it into the current folder area of Matlab, right-click on the installation package, select Install and install it to the My Apps section. The user can then use the software later by simply clicking on the installed software in My App and it will work.
Requirements：
Software using the Guide version requires that the user's Matlab version is prior to version R2021b.
Software using the App Designer version requires the user's Matlab version to be after version R2016.
The Matlab version used by the developer is R2021b and users can change their Matlab version to R2021b if they are experiencing version incompatibility problems.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of
usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably
include in the README.
https://2022.igem.wiki/bit-china/software
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started.
Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps
explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce
the likelihood that the changes inadvertently break something. Having instructions for running tests is especially
helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Software developers accept modifications and contributions to our software from others. Because a software developer is in fact a beginner, during the development of these software, the developer is also gradually learning how to develop the software. Due to the limited knowledge of the developers, there are bound to be many problems during the development process. We also hope that future users will be able to further modify and improve our software in the process of using it.
In the spirit of open source, we have uploaded the files that can be edited in Matlab's Guide interface and App Designer interface. Users at a later stage can further modify and add new functions to the software developed by the developers.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
The software was developed by Yang Li. Let's give a shout out to the handsome developer Lee Yang!
