Code Code Quality

To run the Code Quality and Code Security suite after installing Ocean4DVarNet :

• Install dev dependencies (pylint, black, ...) in the Ocean4DVarNet directory :

  pip install .[dev]
  

• And then run :
  • The code quality tests

    make lint
    

  • The code security tests:

    make security
    

The code quality and code security tests are configured in the pyproject.py file, and are managed as targets in the Makefile file.

The code quality tools are :

• For code quality checks: pylint and ruff
• For code formatting : isort, black and ruff
• For style guide enforcement : flake8
• for type checking : mypy
• for docstring style checks : pydocstyle

The code security are : bandit and safety