Skip to content

Latest commit

 

History

History
143 lines (99 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

143 lines (99 loc) · 2.55 KB
Raw

Contributing to matpower-pip

Environment

To install Python 3.12 environment, use:

python3.12 -m venv env

To activate Python environment, use:

Linux and macOS:

source env/bin/activate

Windows - PowerShell

env\Scripts\Activate.ps1

Windows - Command Prompt

env\Scripts\activate

To deactivate the Python environment, use:

deactivate

Install requirements

pip install pru --upgrade
pru -r requirements-latest.txt

Download and copy matpower

python3
from matpowerpip.downloader import download_matpower, copy_init

download_matpower(matpower_version='7.1')
copy_init()

Install in development mode

pip install -e ."[dev]"

pytest

pytest -n auto -rA -c pyproject.toml --cov-report term-missing --cov=matpower
pytest -rA -c pyproject.toml --cov-report term-missing --cov=matpower --nbmake

Pre-Commit

pre-commit install
pre-commit run --all-files

Notebook example

  1. Use nb-clean to clean the notebook.

    pip install nb-clean
nb-clean add-filter

    for single run:

    nb-clean clean PATH

  2. Make sure to make the example compatible with google-colab==1.0.0. You can use below commands (optional).

    # install octave
!sudo apt-add-repository -y ppa:ubuntuhandbook1/octave > /dev/null 2>&1
!sudo apt -qq update > /dev/null 2>&1
!sudo apt -y -qq install liboctave-dev octave > /dev/null 2>&1

# install oct2py that compatible with colab
import os

from pkg_resources import get_distribution

os.system(
    f"pip install -qq"
    f" ipykernel=={get_distribution('ipykernel').version}"
    f" ipython=={get_distribution('ipython').version}"
    f" tornado=={get_distribution('tornado').version}"
    f" oct2py"
)

# install packages
!pip install -qq matpower matpowercaseframes

    NOTE

    If using octave, make sure to delete the output of the installation cell.

  3. Print matpower version. If used, also print the version of oct2py.

    import oct2py
import matpower

print(f"oct2py version: {oct2py.__version__}")
print(f"matpower version: {matpower.__version__}")

Print README.md

Use pandoc and wkhtmltopdf to create README.pdf

pandoc --pdf-engine=wkhtmltopdf README.md -o README.pdf

Install oct2py in dev locally

cd ../oct2py && pip install -e ".[test]" && cd -