.. comment
	
	all inline tags to start with _how_scpt_checks_

	
.. index:: Scripts; How to - Checking

.. _how_scpt_checks_top:

STEPlib SysML: How To use the Checking Scripts
######################################################

.. include:: /pages/common/pageunderconstruction.txt
	:start-line: 3

This page explains how to use the Checking Scripts of the STEP architecture.

.. contents:: Contents:
		:local:
		:depth: 1
		:backlinks: top

===========================
Installation: Python Setup
===========================
	
-----------------
For Windows users
-----------------

#. Download last release of python 3 here:

	* For 32 bits: https://www.python.org/ftp/python/3.6.2/python-3.6.2-webinstall.exe
	* For 64 bits: https://www.python.org/ftp/python/3.6.2/python-3.6.2-amd64-webinstall.exe
	
#. Execute the file that has been downloaded and follow the instructions.
#. When the installation is finished, you can confirm it by opening up the command prompt and typing the following command: python -V
#. You will now need to make sure you have the latest version by typing::
	
	*python -m pip install -U pip setuptools

-----------------------
For Mac and Linux users
-----------------------

#. Download last release of python 3 here:
	
	* For Macs: https://www.python.org/ftp/python/3.6.2/python-3.6.2-macosx10.6.pkg
	* For Linux: https://www.python.org/ftp/python/3.6.2/Python-3.6.2.tar.xz
	
#. Execute the file that has been downloaded and follow the instructions.
#. When the installation is finished, you can confirm it by opening up the command prompt and typing the following command: python -V
#. You will now need to make sure you have the latest version by typing::

	python -m pip install -U pip setuptools

----------------
Required package
----------------

For each package type pip install NAME-OF-THE-PACKAGE in the command line. Here is the list of packages to install:

* pandas
* lxml

For example: pip install pandas.

	
=============
Execution
=============

In your terminal, type the following:

.. figure:: /images/howto/ht_scpt_checks_01.png 
	:scale: 100%
	
	Command line execution
	
For Example::

	python3 /Users/abc/STEPlib/utils/QualityChecks/CheckXMI  /Users/abc/STEPlib/Core_model/Core_model.xml

On execution completion a log.txt file will have been generated that lists the checks and any errors found.	

	
.. sectionauthor:: |Aminata Mbengue|

.. include:: /keywords.rst