Skip to content

Tools and practices for the scientific community to make better and more reusable Scientific Python packages and applications

License

Notifications You must be signed in to change notification settings

TingwenZhang/scikit-package

 
 

Repository files navigation

Icon

PyPI Forge PythonVersion PR

CI Codecov Black Tracking

scikit-package offers tools and practices for the scientific community to make better and more reusable Scientific Python packages and applications:

  • We help scientists share scientific code to amplify research impact.
  • We help scientists save time, allowing them to focus on writing scientific code.
  • We offer best practices from the group's experience in developing scientific software.

Overview

Here is an overview of the 5 levels of sharing code and the key features of scikit-package:

Diagram of 5 levels of sharing code with key features and scikit-package commands

Demo

Here is how you can use the package create public command to create a new Level 5 Python package called diffpy.my-project in just 1–2 minutes:

Demonstration of creating a new Level 5 package with scikit-package

Getting started

Are you interested in using scikit-package? Begin with the Getting Started page in our online documentation at https://scikit-package.github.io/scikit-package!

How to cite scikit-package

If you use scikit-package to standardize your Python software, we would like you to cite scikit-package:

  1. Lee and C. Myers and A. Yang and T. Zhang and S. J. L. Billinge, scikit-package - software packaging standards and roadmap for sharing reproducible scientific software (https://arxiv.org/abs/2507.03328)

Acknowledgements

This GitHub repository is built and maintained with the help of scikit-package as well.

About

Tools and practices for the scientific community to make better and more reusable Scientific Python packages and applications

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 88.7%
  • Makefile 10.2%
  • Batchfile 1.1%