Skip to main content

A collection of scikit-learn compatible utilities that implement methods developed in the COSMO laboratory

Project description

scikit-cosmo

Test codecov

A collection of scikit-learn compatible utilities that implement methods developed in the COSMO laboratory

Installation

pip install skcosmo 

You can then import skcosmo in your code!

Developing the package

Start by installing the development dependencies:

pip install tox black flake8

Then this package itself

git clone https://github.com/cosmo-epfl/scikit-cosmo
cd scikit-cosmo
pip install -e .

This install the package in development mode, making is importable globally and allowing you to edit the code and directly use the updated version.

Running the tests

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 code formatter when saving your files, there are plugins to do this with all major editors.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

skcosmo-0.1.1.tar.gz (519.7 kB view hashes)

Uploaded Source

Built Distribution

skcosmo-0.1.1-py3-none-any.whl (146.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page