Install Development Build

If you are interested in helping the development of this tool, or you would like to get the cutting-edge version of this tool, you can install this tool via conda.

To do this, ensure you have Miniconda/Anaconda installed on your system. You can download miniconda on their official website.

1. Clone this repository from GitHub:

   git clone git@github.com:UBC-MDS/fixml.git
   

2. Create a conda environment:

   cd fixml && conda env create -f environment.yml
   

3. Activate the newly created conda environment (default name fixml):

   conda activate fixml
   

4. Use poetry which is preinstalled in the conda environment to create a local package install:

   poetry install
   

5. Done! You should now be able to run unit tests to confirm the build works without problems:

   # skip integration tests
   pytest -m "not integeration"
   
   # run ALL tests, which requires OPENAI_API_KEY to be set
   echo "OPENAI_API_KEY={your-openai-api-key}" > .env
   pytest
   

Note

For a more detailed walkthrough on how to set up the OpenAI API key , please refer to the API key section of our installation guide.