dev_install

Developer Installation Instructions

WARNING: In progress!

Note: These instructions are for developers only! If you are a user, who does not intend to modify the PyBERT source code, back up and choose Instant Gratification, instead.

Note: I'm assuming you're working at a Bash, or Sh, prompt. If you're using Csh, please, make the necessary translations to the following commands.

Installing PyBERT in Development mode.

If you wish to install PyBERT in a way that allows you to see immediate feedback to any changes you make to the PyBERT source code, follow these steps:

1. If you haven't already, install the Anaconda Python Distribution.
   Note: Select Python v3.x 64 bit.

2. Launch the Anaconda Command Prompt and create and activate a custom Anaconda environment:

   • conda create -n pybert-dev
   • conda activate pybert-dev

3. Install PyBERT's dependencies into the new environment:

   • conda install -c dbanas -c defaults -c conda-forge --only-deps pybert

4. Fork/clone the PyBERT GitHub repository to your machine.

   1. From the main PyBERT repository, make your own fork of PyBERT by clicking where shown:

      

   2. From your new fork of PyBERT, clone, or download, to your working machine, by clicking where shown:

      

      and entering the following command:

      git clone <PASTE>

5. From the same Anaconda command prompt you used, above, to create and activate the pybert-dev environment, move into the newly created PyBERT directory and execute the command:

   conda develop .

6. Test your new development mode installation of PyBERT, by executing the following command:

   python -m pybert

   You should see the usual PyBERT GUI application appear on your screen.

You are now ready to begin changing the PyBERT source code and testing those changes. Of course, you must quit and restart PyBERT, after making a source code change, in order to see its effects.

Installing PyAMI in Development mode.

If you also wish to install PyAMI in development mode, enter the following commands from the same Anaconda Command Prompt from within the PyBERT directory:

1. git submodule update --init PyAMI/
2. conda uninstall --force pyibis-ami
3. conda develop .\PyAMI\
4. python -c "import pyibisami as dut; print(dut.__file__)"

In response to the last command, you should see something like:

C:\Users\capnf\Documents\GitHub\PyBERT\PyAMI\pyibisami\__init__.py