lines 6-115 of file: setup.py

{xrst_begin_parent setup.py}
{xrst_spell
   cd
   dist
   eval
   grep
   gz
   pyproject
   pytest
   sed
   toml
   xam
}

Install cppad_py Python Module
##############################

See Also
********
:ref:`old_setup.py-name`

Errors
******
If you encounter an error during this process,
see :ref:`setup.py.error-name` .

cppad_py.git
************
To begin the install process,
create the cppad_py.git directory and make it the current
working directory as follows::

   git clone https://github.com/bradbell/cppad_py.git cppad_py.git
   cd cppad_py.git


version
*******
We use version for its value in the pyproject.toml file
(not including the quotes).
You can set the shell variable version to
this value, and see the value, with the following commands::

   eval $(grep '^version *=' pyproject.toml | sed -e 's| ||g')
   echo $version

System Dependencies
*******************
The following command will use your system package manager to
install some packages required by cppad_py::

   bin/system_depend.sh

Simple Case
***********
In the simple case,
the install setting :ref:`install_settings.py@include_mixed` is false.
After possibly changing some of the other settings in
:ref:`install_settings.py-name`, execute the following commands::

   bin/get_cppad.sh
   python3 -m build
   pip install dist/cppad_py-$version.tar.gz

You may need to add ``--user`` of specify some other install
prefix in the pip command above.
If you use this form of the install,
you will not be able to use any of the :ref:`mixed-name` routines.

Example
=======
If you place the Python Code below in the file ``temp.py`` ,
the following command should execute without error::

   python3 temp.py

Python Code:
{xrst_literal
   readme.md
   # BEGIN PYTHON
   # END PYTHON
}

Testing
=======
The following command will test this install::

   pytest example/python/core/*_xam.py


Mixed Case
**********
In the mixed case, :ref:`install_settings.py@include_mixed` is true.
After possibly changing some of the other settings in
:ref:`install_settings.py-name`, execute the following commands::

   bin/get_cppad_mixed.sh
   python3 -m build
   pip install dist/cppad_py-$version.tar.gz

If you use this form of the install,
you will be able to use any of the :ref:`mixed-name` routines.

Testing
=======
The following command will test this install::

   pytest example/python/*/*_xam.py

{xrst_end setup.py}