Getting started
==============================

This guide is here to help you start using PyProcar with the help of our examples and tutorials.


.. toctree::
   :hidden:

   installation
   authors
   why

Installation
-------------------------------
The only prerequisite for installing PyProcar is Python itself. If you don’t
have Python yet and want the simplest way to get started, we recommend you use
the `Anaconda Distribution <https://www.anaconda.com/>`_.


.. grid:: 2

    .. grid-item-card:: Working with conda?
       :class-title: pyprocar-card-title

       PyProcar is available on `conda-forge
       <https://anaconda.org/conda-forge/pyprocar>`_.

       .. code-block:: bash

          conda install -c conda-forge pyprocar

    .. grid-item-card:: Prefer pip?
       :class-title: pyprocar-card-title

       PyProcar can be installed via pip from `PyPI
       <https://pypi.org/project/pyprocar>`__.

       .. code-block:: bash

          pip install pyprocar

.. grid::

   .. grid-item-card:: In-depth instructions?
      :link: install_ref
      :link-type: ref
      :class-title: pyprocar-card-title

      Installing a specific version? Installing from source? Check the
      :ref:`install_ref` page.

Paper
-------------------------------

.. grid:: 2

   .. grid-item-card:: 1st Publication
      :link: authors_ref
      :link-type: ref
      :class-title: pyprocar-card-title

      Using PyProcar in your research? Please consider citing or acknowledging
      us.  We have a Elsevier Publication!

      .. image:: ../images/1st_publication.png
         :target: https://www.sciencedirect.com/science/article/abs/pii/S0010465519303935?via%3Dihub

   .. grid-item-card:: 2nd Publication
      :link: authors_ref
      :link-type: ref
      :class-title: pyprocar-card-title

      Using PyProcar in your research? Please consider citing or acknowledging
      us.  We have a Elsevier Publication!

      .. image:: ../images/2nd_publication.png
         :target: https://www.sciencedirect.com/science/article/abs/pii/S0010465523004083





Support
-------------------------------

If you want to support the PyProcar please see the `Contributing page <https://github.com/romerogroup/pyprocar/blob/main/CONTRIBUTING.rst>`_.

Citing PyProcar
-------------------------------

There are two papers about PyProcar: `1st Paper <https://doi.org/10.1016/j.cpc.2019.107080>`_ and `2nd Paper <https://doi.org/10.1016/j.cpc.2023.109063>`_.

If you are using PyProcar in your scientific research, please help our scientific
visibility by citing our work! Head over to :ref:`citation_ref` to learn more
about citing PyProcar.