Metadata-Version: 2.1
Name: MFAProblem
Version: 1.0.0b8
Summary: Material Flow Analysis Problem
Home-page: https://gitlab.com/su-model/mfa_problem
Author: AFM Filieres
Author-email: julien.alapetite@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/x-rst
Requires-Dist: openpyxl
Requires-Dist: pandas
Requires-Dist: sympy
Requires-Dist: cvxpy
Requires-Dist: argparse
Requires-Dist: pybind11
Requires-Dist: xmltodict
Requires-Dist: psutil
Requires-Dist: sqlalchemy
Requires-Dist: xlrd
Requires-Dist: parameterized
Requires-Dist: numpy

MFA Problem
***********
Prerequisite
------------
Git and Python installed. Preferably installed with conda and inside a virtual environment.

Installation
------------
In a shell, in a working folder type:

* git clone https://gitlab.com/libeigen/eigen.git
* On linux or MAC: export EIGEN_INCLUDE="Eigen Path" 
* On windoxs: set EIGEN_INCLUDE="Eigen Path"
* pip install MFAProblem

Test
----
To run the tests:
* python -m unittest discover mfa_problem.tests.unit
* python -m unittest discover mfa_problem.tests.integration

Run exemples
------------
Get the examples: 
git clone https://gitlab.com/greel/mfa-problem-test.git
Run the examples (modify file path):
* run_mfa_problem_main_with_excel.py --input_file reconciliation\pommes_poires.xlsx
* run_create_empty_ter.py --input_file create\pommes_poires.xlsx
* run_mfa_problem_check_input.py --input_file check\orge_new_segm.xlsx

Modify options:
* run_mfa_problem_main_with_excel.py --input_file reconciliation\pommes_poires.xlsx --output_dir input
* run_mfa_problem_main_with_excel.py --input_file reconciliation\pommes_poires.xlsx --output_dir path C:\users\julie
* run_create_empty_ter.py --input_file create\pommes_poires.xlsx --output_dir input
* run_create_empty_ter.py --input_file create\pommes_poires.xlsx --output_dir C:\users\julie
* run_mfa_problem_check_input.py --input_file check\orge_new_segm.xlsx --output_dir input
* run_mfa_problem_check_input.py --input_file check\orge_new_segm.xlsx --output_dir path C:\users\julie

Standalone to see doc:
* run_mfa_problem_main_with_excel.py
* run_create_empty_ter.py
* run_mfa_problem_check_input.py

Notebooks
---------
In a shell in the same folder as above:
* pip install jupyter
* pip install ipyfilechooser
* install_mfa_problem_notebook.py
* cd ~/mfa_problem_notebook
* jupyter notebook basic_workflow.ipynb

Project
-------
* https://gitlab.com/su-model/mfa_problem

