Developer Notes

Making changes to the UI

The UI is build using Vuejs cli and requires npm to run. Once setup, changes to the ui source code will be reflected immidiately in the browser.

  1. Run the UI using `npm run serve`

  2. By default, changes will be reflected at http://localhost:8080

Building for Readonly Viewing

pip install -e . -no-deps
pip install -r requirements-webreadonly.txt

Building for PiPy

  1. Run Tests with tox

    pip install tox
    tox
    
  2. Building wheel and source distribution and view files

    rm -rf build dist *.egg-info &&
    python setup.py bdist_wheel && python -m build --sdist --wheel && unzip -l dist/*.whl
    
  3. Uploading to PiPy

    pip install twine
    twine upload dist/*
    

Building the Documentation

  1. Rebuild API Docs

    From the project root, run:

    cd docs
    sphinx-apidoc -o source ../pistarlab
    
  2. Update the HTML

    cd docs
    make html
    

Building and Publishing a new Docker Image

Instructions on how to create a docker image from an Ubuntu environment

  1. Make changes to docker file

  2. Update requirements.txt
    
    

    conda create -n pistarlab377 python=3.7.7 conda activate pistarlab377 pip install -e . pip freeze > requirements.txt

  3. Run Docker Build

./build_docker