[BUG] Cannot install Latest version of CityLearn

[sasidhar96]

Issue Description

Installation of the latest version of CityLearn (2.3.0) fails on macOS with Apple Silicon due to dependency conflicts and compilation errors, particularly with openstudio and scikit-learn dependencies.

Expected Behavior

The installation of CityLearn 2.3.0 should complete successfully with all dependencies properly installed, allowing the package to be imported and used in Python scripts.

Actual Behavior

1. Cannot find a compatible version of openstudio<=3.3.0 for the current system architecture
2. Compilation errors with scikit-learn 1.0.2 related to OpenMP support
3. Circular dependency issues between doe-xstock and openstudio

Steps to Reproduce

Error Messages
ERROR: Could not find a version that satisfies the requirement openstudio<=3.3.0 (from versions: 3.5.0, 3.5.1, 3.6.0, 3.6.1, 3.7.0rc1, 3.7.0, 3.8.0, 3.9.0)
ERROR: No matching distribution found for openstudio<=3.3.0

Environment

• CityLearn version: Attempted to install 2.3.0 (latest)
• Dataset name/link: N/A (installation issue)
• Operating System: macOS (Apple Silicon/ARM64)
• Python version: 3.11

Possible Solution

If you have any ideas for how to fix the issue, please describe them here.

Additional Notes

1. The issue appears to be specific to Apple Silicon Macs, which require ARM64-compatible binaries
2. CityLearn 2.1.1 can be successfully installed using the --no-deps approach and works for basic functionality
3. The OpenMP compilation error is a common issue on macOS systems and not specific to CityLearn
4. Future versions of CityLearn should consider providing more flexible dependency specifications to accommodate different system architectures
5. I am not that good when it comes to these installation issues, so would really help the guidance and working fix

[John-Chen92]

I also encountered this problem:

ERROR: Ignored the following versions that require a different python version: 1.21.2 Requires-Python >=3.7,<3.11; 1.21.3 Requires-Python >=3.7,<3.11; 1.21.4 Requires-Python >=3.7,<3.11; 1.21.5 Requires-Python >=3.7,<3.11; 1.21.6 Requires-Python >=3.7,<3.11
ERROR: Could not find a version that satisfies the requirement openstudio<=3.3.0 (from citylearn) (from versions: 3.5.0, 3.5.1, 3.6.0, 3.6.1, 3.7.0rc1, 3.7.0, 3.8.0, 3.9.0)
ERROR: No matching distribution found for openstudio<=3.3.0

Switching to Python 3.9 resolves this issue.

After that, running

pip install --no-deps citylearn==2.3.0

allows the installation to complete successfully. However, when running the package, the following error appears:

  35 REPOSITORY_NAME = 'CityLearn'
  36 REPOSITORY_TAG = f'v{__version__}'
--> 37 REPOSITORY_DATA_PATH = join_url('data')
  38 REPOSITORY_DATA_DATASETS_PATH = join_url(REPOSITORY_DATA_PATH, 'datasets')
  39 REPOSITORY_DATA_MISC_PATH = join_url(REPOSITORY_DATA_PATH, 'misc')

TypeError: 'staticmethod' object is not callable

This issue has been reported here:
#137

[kingsleynweye]

I also encountered this problem:

ERROR: Ignored the following versions that require a different python version: 1.21.2 Requires-Python >=3.7,<3.11; 1.21.3 Requires-Python >=3.7,<3.11; 1.21.4 Requires-Python >=3.7,<3.11; 1.21.5 Requires-Python >=3.7,<3.11; 1.21.6 Requires-Python >=3.7,<3.11
ERROR: Could not find a version that satisfies the requirement openstudio<=3.3.0 (from citylearn) (from versions: 3.5.0, 3.5.1, 3.6.0, 3.6.1, 3.7.0rc1, 3.7.0, 3.8.0, 3.9.0)
ERROR: No matching distribution found for openstudio<=3.3.0

Switching to Python 3.9 resolves this issue.

After that, running

pip install --no-deps citylearn==2.3.0

allows the installation to complete successfully. However, when running the package, the following error appears:

  35 REPOSITORY_NAME = 'CityLearn'
  36 REPOSITORY_TAG = f'v{__version__}'
--> 37 REPOSITORY_DATA_PATH = join_url('data')
  38 REPOSITORY_DATA_DATASETS_PATH = join_url(REPOSITORY_DATA_PATH, 'datasets')
  39 REPOSITORY_DATA_MISC_PATH = join_url(REPOSITORY_DATA_PATH, 'misc')

TypeError: 'staticmethod' object is not callable

This issue has been reported here: #137

Please see #137 (comment)

[kingsleynweye]

Issue Description

Installation of the latest version of CityLearn (2.3.0) fails on macOS with Apple Silicon due to dependency conflicts and compilation errors, particularly with openstudio and scikit-learn dependencies.

Expected Behavior

The installation of CityLearn 2.3.0 should complete successfully with all dependencies properly installed, allowing the package to be imported and used in Python scripts.

Actual Behavior

1. Cannot find a compatible version of openstudio<=3.3.0 for the current system architecture
2. Compilation errors with scikit-learn 1.0.2 related to OpenMP support
3. Circular dependency issues between doe-xstock and openstudio

Steps to Reproduce

Error Messages ERROR: Could not find a version that satisfies the requirement openstudio<=3.3.0 (from versions: 3.5.0, 3.5.1, 3.6.0, 3.6.1, 3.7.0rc1, 3.7.0, 3.8.0, 3.9.0) ERROR: No matching distribution found for openstudio<=3.3.0

Environment

• CityLearn version: Attempted to install 2.3.0 (latest)
• Dataset name/link: N/A (installation issue)
• Operating System: macOS (Apple Silicon/ARM64)
• Python version: 3.11

Possible Solution

If you have any ideas for how to fix the issue, please describe them here.

Additional Notes

1. The issue appears to be specific to Apple Silicon Macs, which require ARM64-compatible binaries
2. CityLearn 2.1.1 can be successfully installed using the --no-deps approach and works for basic functionality
3. The OpenMP compilation error is a common issue on macOS systems and not specific to CityLearn
4. Future versions of CityLearn should consider providing more flexible dependency specifications to accommodate different system architectures
5. I am not that good when it comes to these installation issues, so would really help the guidance and working fix

Hi, I am not familiar with this installation challenge. I could find some time to debug it but it might take a while before I get to it. Were you able to find a solution?

[MaPaKo]

I currently get the same error, so the problem is not exclusive to Apple. My setup:

• Windows 11
• VS Code 1.104.1
• Python 3.10
• CityLearn 2.4.2 with pip install (unsuccessful)

It appears to me that the developers had an old version of OpenStudio installed on their computers that is no longer available.

[kingsleynweye]

@MaPaKo sorry about the issue you are facing. Please, for now install CityLearn==2.3.1 or earlier. The 2.4.0-2.4.2 versions were yanked because they had major bugs that are being resolved. What was introduced in 2.4.x is the EV models and if you don't need those, you should be fine with 2.3.1. Let me know how it goes.