Package: lind
MIT LicenseCopyright (c) 2020 James MontgomeryPermission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.Description: # LindA short description.### AuthorsJames Montgomery-Initial Work- [jamesmontgomery.us](http://jamesmontgomery.us)### LicenseThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details## Getting StartedThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.### InstallingFor a local installation, first git clone this repository. Then follow these instructions:` pip install . `To install from [pypi](https://pypi.org/):` pip install-Ulind `To install the package with test dependencies add[“tests”]to the install command:` pip install.["tests"]# or pip install-Ulind["tests"]`## TestingTesting is an important part of creating maintainable, production grade code. Below are instructions for running unit and style tests as well as installing the necessary testing packages. Tests have intentionally been separated from the installable pypi package for a variety of reasons.Make sure you have the required testing packages:` pip install-rrequirements_test.txt `To install the project  with test dependencies see the install section.### Running the unit testsWe use the pytest framework for unit testing.` pytest-vvl-s--covlind--disable-pytest-warnings`### Running the style testsHaving neat and legible code is important. Having documentation is also important. We use pylint as our style guide framework. Many of our naming conventions follow directly from the literary sources they come from. This makes it easier to read the mathematical equations and see how they translate into the code. This sometimes forces us to break pep8 conventions for naming.` pylint lind--disable=invalid-name`## Contributor’s GuideHere are some basic guidelines for contributing.### Branch StrategyThis repository doesn’t use a complicated branching strategy. Simply create a feature branch off of master. When the feature is ready to be integrated with master, submit a pull request. A pull request will re quire at least one peer review and approval from the repository owner.### Style GuidePlease stick to pep8 standards when for your code. Use numpy style docstrings.### Test RequirementsPlease use pytest as your testing suite. You code should have >= 80% coverage.### Updating the DocsUpdating the documentation is simple. First, let auto-docs check for updates to the package structure.` cd docs make html `## AcknowledgmentsPeople to acknowledge.## TODOFeatures to be added / change / fixed.## Useful ResourcesUseful resources for understanding the package.Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: tests