https://github.com/romerogroup/pyprocar
Raw File
Tip revision: 5a01c23f18b65742af81b9498ee0538a274e6fe3 authored by lllangWV on 01 April 2023, 16:25:08 UTC
Fermi surface refactor
Tip revision: 5a01c23
CONTRIBUTING.rst
Contributing
==================================

We absolutely welcome contributions and we hope that this guide will
facilitate an understanding of the PyProcar code repository. It is
important to note that the PyProcar software package is maintained on a
volunteer basis and thus we need to foster a community that can support
user questions and develop new features to make this software a useful
tool for all users.

This page is dedicated to outline where you should start with your
question, concern, feature request, or desire to contribute.

Being Respectful
-----------------------------------

Please demonstrate empathy and kindness toward other people, other software,
and the communities who have worked diligently to build (un-)related tools.

Please do not talk down in Pull Requests, Issues, or otherwise in a way that
portrays other people or their works in a negative light.

Cloning the Source Repository
-----------------------------------

You can clone the source repository from
`<https://github.com/romerogroup/pyprocar>`_ and install the latest version by
running:

.. code:: bash

   git clone https://github.com/romerogroup/pyprocar.git
   cd pyprocar
   python -m pip install -e .
   git checkout dev
back to top