Troubleshooting frequently made mistakes

[Lukas-Kunz]

Are you facing any problems while running your dataset that you cannot resolve? Have a look at the following Q&A:

Q: While running the framework I encounter a ModuleNotFoundError.
A: Ensure that you have activated the newest version of the ZEN garden virtual environment (All the needed modules are included there). To do so, go to settings (file->settings) and check if the default python interpreter is the ZEN garden environment. If that is the case, check if the missing module is contained in the package list of the environment (screenshot):

Now there are two options:
a. Module is contained: Most certainly you are running the framework with a configuration that specifies a different python interpreter. Check if the default project python interpreter (which should be the ZEN garden environment) is chosen in the configuration you are using to execute the framework:

b. You are not using the newest ZEN garden environment version. To re-install the environment, run the following two commands in your Anaconda Prompt (must be done in the directory, where the ZEN garden package is located-> use command cd/ZEN-garden (path of ZEN garden)):
conda remove --name zen-garden-linopy --all (replace zen-garden-linopy by your environment name if it is named differently)
conda env create -f zen_garden_env.yml
After updating the ZEN garden environment, ensure again if the environment is set as the default python interpreter and if the module can now be found in the package list.

Q: My dataset is infeasible.
A: Estimate if the following criteria are fulfilled:

1. Can the specified carrier demands be produced with the available technologies?
2. Can the specified demands be met without violating the defined carbon emissions specifications?
3. Can the needed technologies be built on time? (construction_time > 0 and capacity_existing = 0)

Q: When I try to run my dataset I get the error FileNotFoundError: system.py not found in dataset: C:\ZEN-garden\data\my_dataset.
A: Your dataset is not located in the data folder. To execute a dataset it must be placed in the data directory.

Q: I get the error "pint.errors.UndefinedUnitError: 'KWh' is not defined in the unit registry", what's wrong?
A: Your prefix should/shouldn't be capitalized e.g. kilo --> k (not K), mega --> M (not m), etc.

Q: I encounter the error "pandas.errors.ParserError: Error tokenizing data. C error: Expected 3 fields in line 10, saw 4" while reading the input data.
A: There's an input csv file showing more commas (separators) than the other rows do.

[hegnerl]

Q: when submitting a job to euler using sbatch, I'm getting the error sbatch: error: Invalid --distribution specification despite not passing this argument at all or passing it correctly into sbatch. Or I get another error related to an input argument that looks to be formulated correctly.
A: make sure the input command is being parsed correctly.
Copy-pasting a command such as sbatch --ntasks=32 --mem-per-cpu=2048 --time=2:00:00 --ntasks-per-node=32 --wrap=“python -m zen_garden” from e.g. slack could result in a wrong interpretation of the arguments passed. --> the quotation marks (") might not be parsed as such. Manually typing out the command will fix this issue

Q: when setting up euler, when building the virtual environment (./create_env_euler.sh), I'm getting the error:
"Using cached PyYAML-5.4.1.tar.gz (175 kB)
Installing build dependencies ... done
Getting requirements to build wheel ... error
error: subprocess-exited-with-error
...
AttributeError: cython_sources
[end of output]"
A: 1) add the 2 highlighted lines to create_env_euler.sh.
pip install "cython<3.0.0" wheel
pip install "pyyaml==5.4.1" --no-build-isolation
2) make sure that the gurobipy version in requirements.txt is specified to be ==10.0 (this might change in future)