juanfung / pycge Goto Github PK

Not generally included with python or anconda. Either:

(1) explicitly state dependency and instructions for installation (one of pip install dill or conda install -c anaconda dill); or

(2) conditionally install it as part of the pycge package.

Hi Juan,
Good works on CGE!
I got an error when I try to run the stdcge_model_def.py

from pyomo.environ import *
from pycge.examples.stdcge_model_def import StdModelDef
from pycge.PyCGE import PyCGE

The error I got is like this:

Traceback (most recent call last):
  File "c:\Users\SIXU GUO\Desktop\CGE_MODEL\pycge_model\pycge-master\pycge\examples\stdcge.py", line 12, in <module>
    from pycge.examples.stdcge_model_def import StdModelDef
ModuleNotFoundError: No module named 'pycge'

I'm wondering if you know what I'm doing wrong?

Current documentation has TODO in the section "Local Solvers."

Add simple instructions for getting started (e.g., solver suggestions, link to binaries).

PyCGE is a class; the module containing it should be lower case, pycge.py, per PEP-8 style guide.

Add simple instructions on how user can use custom model definitions with the package.

• ModelDef class structure
• current directory or add to sys.path, etc

The section "Installation" is missing.

• For now: git clone or pip install git.
• TODO: add to pypi?

Also, the "Requirements" section only has instructions for pip install pyomo. Need to add conda install option and also note that pyomo install pyomo.extras is currently broken: Pyomo/pyomo#243

In setup.py, add the following:

python_requires~=3.6

Data used in the examples currently stored under pycge/pycge/data/, and included in MANIFEST.in

Example model definitions and scripts, currently stored under pycge/pycge/examples/, can be loaded as modules; e.g., from pycge.examples.splcge_model_def import SplModelDef.

A user cannot easily access the data. The best option afaik is:

import os, sys
os.path.dirname(sys.modules['pycge'].__file__)+'/data/path_to_data' 

It might be better to automatically load the data when loading the module. For example, by adding the above commands to splcge_model_def.py.