Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 2.9 KB

README.md

File metadata and controls

80 lines (52 loc) · 2.9 KB
Raw

Docs Test Coverage CI

fair-python-cookiecutter-demo

⚠️ TODO: Complete project setup 🚧

This is a Python project generated from the fair-python-cookiecutter template.

TODO: To finalize the project setup, please carefully read and follow the instructions in the developer guide. A copy of the guide is included in your project in docs/dev_guide.md.

TODO - add description

🚧 TODO: Write a paragraph summarizing what this project is about.

Installation

TODO: check that the installation instructions work

This project works with Python > 3.8.

pip install git+ssh://git@github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter-demo.git

Getting Started

TODO: provide a minimal working example

Troubleshooting

When I try installing the package, I get an IndexError: list index out of range

Make sure you have pip > 21.2 (see pip --version), older versions have a bug causing this problem. If the installed version is older, you can upgrade it with pip install --upgrade pip and then try again to install the package.

You can find more information on using and contributing to this repository in the documentation.

How to Cite

If you want to cite this project in your scientific work, please use the citation file in the repository.

Acknowledgements

We kindly thank all authors and contributors.

TODO: relevant organizational acknowledgements (employers, funders)