JADE source code repository
Documentation: https://nrel.github.io/jade/
Tutorial: https://nrel.github.io/jade/tutorial.html
This project uses conda to manage software dependencies.
Please make sure conda
has already been installed on your machine, or follow the
guide to install.
Use the commands below to create the virtual environment for Python, and install the required packages.
Create virtual environment
conda env create -f environment.yml
# or
conda env create -f dev-environment.yml
Activate virtual environment
conda activate jade
Deactivate virtual environment
conda deactivate
The dev packages require that pandoc and plantuml be installed.
- Refer to https://pandoc.org/installing.html
- plantuml on Mac:
brew install plantuml
- plantuml on Linux:
sudo apt-get install plantuml
- plantuml on Windows: http://plantuml.com/starting
Installation:
pip install -e '.[dev]'
This project uses pytest as the framework to run unit tests
and integration tests, and generate HTML reports of coverage with the plugin
pytest-cov. The following are some basic commands
for running tests with pytest
.
Run unit tests
pytest --cov=jade tests/unit/ --cov-report=html -v
Run integration tests
pytest --cov=jade tests/integration/ --cov-report=html -v
Run test on a specific Python module
pytest --cov=jade tests/unit/utils/test_utils.py -v
Run test on a specific Python function
pytest --cov=jade tests/unit/utils/test_utils.py::test_create_chunks -v
Run test with debug logging activated
pytest tests/unit/jobs/test_job_queue.py --log-cli-level=debug
For more details and examples, please refer to the official pytest documentation.