To use the aida_interchange package within your project, you must first install it. It is recommended that you install aida_interchange into a python3 virtual environment. See Python Virtual Environment README for more details on creating and using a virtual environment.
To install aida_interchange, make sure a Python Virtual Environment is activated, navigate to the AIDA-Interchange-Format/python directory, and run the following command:
$ python3 setup.py installThe aida_interchange modules can now be imported into your project.
The python project uses Sphinx for generating documentation. To generate the documentation, make sure a Python Virtual Environment is activated, navigate to the AIDA-Interchange-Format/python/docs directory, and run the update_documentation.sh script.
$ cd docs
$ ./update_documentation.shThis script will generate documentation in the form of HTML and place it within the AIDA-Interchange-Format/python/docs/build/html folder.