ADI Python Bindings

To develop adi_py, use the conda_environment.yml to set up a conda environment before you build.

conda env create -f conda_environment.yml
conda activate adi_py

Building in Dev Mode

You need to build adi_py in dev mode so that the source code is linked. Then you don't have to re-build every time you make code changes:

cd ~/code.arm.gov/adi/adi_py
./build.sh --dev

Unit Tests

Run these tests from your adi_py conda environment in order to test your code:

1. Run dsproc_test on tutorial_py to test the new API

   cd ~/code.arm.gov/vap/tutorial_py
   conda activate adi_py
   ./build.sh
   cd test
   dsproc_test

2. Run adi_example1_py_newapi -s sbs -f S2 -b 20110401 -e 20110402 -D 1 -R to test that it successfully runs

   cd ~/code.arm.gov/vap/adi_example1_py_newapi
   conda activate adi_py
   ./build.sh
   adi_example1_py_newapi -s sbs -f S2 -b 20110401 -e 20110402 -D 1 -R

TODO: Need a complete test that uses all of the methods in the new adi_py to check if api changes cause a crash. We can add them to adi_example_1_py_newapi or tutorial_py.

Releasing via APR

cd ~/code.arm.gov/adi/adi_py
apr minor -conf package/adi_py36.yaml

Read The Docs

The documenation is currently located on Read The Docs here: https://adi-python.readthedocs.io/en/latest/

The adi_py code.arm.gov repo is currently set up with a GitLab CICD build which will trigger a readthedocs web hook to run the build. To edit the web hook, go here: https://readthedocs.org/dashboard/adi-python/integrations/