https://github.com/mdanalysis/cookiecutter-mdakit

Cookiecutter for Python packages based on MDAnalysis
https://github.com/mdanalysis/cookiecutter-mdakit

Last synced: 10 months ago
JSON representation

Cookiecutter for Python packages based on MDAnalysis

• Host: GitHub
• URL: https://github.com/mdanalysis/cookiecutter-mdakit
• Owner: MDAnalysis
• License: mit
• Created: 2022-06-10T22:30:32.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-07-27T05:27:22.000Z (11 months ago)
• Last Synced: 2025-08-28T17:54:48.841Z (10 months ago)
• Language: Python
• Homepage:
• Size: 6.33 MB
• Stars: 7
• Watchers: 4
• Forks: 5
• Open Issues: 41
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

          
# Cookiecutter for MDAnalysis-based packages

[//]: # (Badges)

[![GitHub Actions Build Status](https://github.com/MDAnalysis/cookiecutter-mdakit/actions/workflows/gh-ci.yaml/badge.svg)](https://github.com/MDAnalysis/cookiecutter-mdakit/actions?query=workflow%3A%22Cookiecutter+CI%22)

[![Documentation Status](https://readthedocs.org/projects/cookiecutter-mdakit/badge/?version=latest)](https://www.mdanalysis.org/cookiecutter-mdakit)

A [cookiecutter](https://github.com/audreyr/cookiecutter) template for those interested in developing

packages based on MDAnalysis. Starting repositories can be created from this template so you can focus on what's important: the science!

Examples of generated "cookie" repositories can be found in the branches of https://github.com/MDAnalysis/mdakit-cookie.

This repository is automatically updated by CI in this cookiecutter repository.

## Requirements

* Python 3.9+

* [Cookiecutter](http://cookiecutter.readthedocs.io/en/latest/installation.html) 2+

* [Git](https://git-scm.com/)

## Usage

With [`cookiecutter` installed](https://cookiecutter.readthedocs.io/en/latest/installation.html#install-cookiecutter),

execute the following command inside the folder you want to create the skeletal repository. Follow the prompts or hit enter for the default options.

```bash

cookiecutter gh:MDAnalysis/cookiecutter-mdakit

```

Please see our documentation for more details on how to use the cookiecutter.

## Acknowledgments

This cookiecutter is developed by MDAnalysis, based heavily off the

[Cookiecutter for Computational Molecular Sciences (CMS) Python Packages](https://github.com/MolSSI/cookiecutter-cms)

by Levi N. Naden and Jessica A. Nash

from the [Molecular Sciences Software Institute (MolSSI)](http://molssi.org/) and

Daniel G. A. Smith of [ENTOS](https://www.entos.ai/).

The development of this repository is supported by a grant from the Chan Zuckerberg Initiative under an EOSS4 award.