Welcome to kmc’s documentation!¶

We write here a little bit about the packages and include images.

Installation¶

Conda¶

Eventually conda images will be built for application.

Docker Images¶

Eventually docker images will be build for application.

Nixpkgs¶

costrouc is a contributor to nixpkgs which is a novel way to package applications and libraries. He will work to ensure that this package is easily installable via nix.

building :: nix-build .nix/default.nix

virtualenv with package :: nix-shell .nix/shell.nix

Development¶

For development conda is recommended.

conda env create -n kmc -f dev-environment.yml
source activate kmc

From here you will have all the necissary dependencies. You can run all the tests, coverage, and style enforcement with the following command.

python setup.py test

Documentation is done with sphinx. You will need to get comfortable with using restructuredText. To update the api documentation you will need to run sphinx-apidoc within the doc directory.

License¶

Currently the [Unlicense](https://choosealicense.com/licenses/unlicense/) is used. This will allow for when the repo is transfered that there are no issues with copyright.

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

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 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.

For more information, please refer to <http://unlicense.org/>