Metadata-Version: 2.1
Name: skcosmo
Version: 0.1.0
Summary: A collection of scikit-learn compatible utilities that implement methods developed in the COSMO laboratory
Home-page: http://scikit-cosmo.readthedocs.io
Author: Rose K. Cersonsky, Guillaume Fraux, Sergei Kliavinek, Alexander Goscinski, Benjamin A. Helfrecht, Michele Ceriotti
Author-email: rose.cersonsky@epfl.ch
License: UNKNOWN
Description: # scikit-cosmo
        
        [![Test](https://github.com/cosmo-epfl/scikit-cosmo/workflows/Test/badge.svg)](https://github.com/cosmo-epfl/scikit-cosmo/actions?query=workflow%3ATest)
        [![codecov](https://codecov.io/gh/cosmo-epfl/scikit-cosmo/branch/main/graph/badge.svg?token=UZJPJG34SM)](https://codecov.io/gh/cosmo-epfl/scikit-cosmo/)
        
        A collection of scikit-learn compatible utilities that implement methods
        developed in the COSMO laboratory
        
        ## Installation
        
        ```bash
        pip install git+https://github.com/cosmo-epfl/scikit-cosmo
        ```
        
        You can then `import skcosmo` in your code!
        
        ## Developing the package
        
        Start by installing the development dependencies:
        
        ```bash
        pip install tox black flake8
        ```
        
        Then this package itself
        
        ```bash
        git clone https://github.com/cosmo-epfl/scikit-cosmo
        cd scikit-cosmo
        pip install -e .
        ```
        
        This install the package in development mode, making is `import`able globally
        and allowing you to edit the code and directly use the updated version.
        
        ### Running the tests
        
        ```bash
        cd <scikit-cosmo PATH>
        # run unit tests
        tox
        # run the code formatter
        black --check .
        # run the linter
        flake8
        ```
        
        You may want to setup your editor to automatically apply the
        [black](https://black.readthedocs.io/en/stable/) code formatter when saving your
        files, there are plugins to do this with [all major
        editors](https://black.readthedocs.io/en/stable/editor_integration.html).
        
        ## License and developers
        
        This project is distributed under the BSD-3-Clauses license. By contributing to
        it you agree to distribute your changes under the same license.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown
