Development
-----------

This tool is a work-in-progress tool. Feel free to contribute. Here is a
non-exhaustif list of TODO:

- add tests
- add examples
- expand documentation
- multi-site PSCF
- add windrose tool in the GUI
- add a propor setup.py file... and use pypi
- ...

Code is hosted at https://gricad-gitlab.univ-grenoble-alpes.fr/webersa/pyPSCF/ .

Issues
~~~~~~

You can submit issues or suggestion directly throught github using the `issue
tracker <https://gricad-gitlab.univ-grenoble-alpes.fr/webersa/pyPSCF/issues>`_

Install the git version
~~~~~~~~~~~~~~~~~~~~~~~

-  Fork repository::
    
    git clone https://gricad-gitlab.univ-grenoble-alpes.fr/webersa/pyPSCF.git
    cd pyPSCF
    python3 -m venv venv  # create a virtual environment
    python3 -m pip install -r requirements.txt  # install the requirements
    source venv/bin/activate
    
-  Create a branch which fix a given issue
-  Submit pull requests