ICoCo API - Version 2 (02/2021)

• ICoCo API - Version 2 (02/2021)
  • Documentation
  • Install
  • Developpement environment
  • Source code
  • Code testing
  • Code documentation

This project implements ICoCo API in Python based on medcoupling.

Documentation

See the documentation of the package

See also the ogirinal documentation for full reference.

Install

This package is available on PyPi, so to install a released version:

python3 -m pip install "icoco~=2.0.0"

Developpement environment

First create the environment:

. ./create_environment.sh

It creates a venv virtual environment environment-icoco and adds extra paths to run medcoupling in it.

It also adds the following aliases:

• icoco-pytest: to run use cases tests
• icoco-use-cases: to run use cases implemented in test_ functions (using pytest)
• icoco-pylint: to run pylint for all python files of the project
• icoco-sphinx: to initialize sphinx doc
• icoco-sphinx-build: to rebuild sphinx doc from previous structure

Note: deactivate function of venv is not able to revert the modified PYTHONPATH and the aliases defined.

Source code

Source code shared between use cases is expected to be in src directory implemented as package(s). See its README for more details.

Code testing

Code testing is powered by pytest. See its README for more details.

Code documentation

A basic sphinx documentation can be generated. See its README for more details.