Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bugfix/python versions #110

Merged
merged 2 commits into from
Jan 24, 2025
Merged

Bugfix/python versions #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62f7418
Merge pull request #108 from IMMM-SFA/dev
crvernon Sep 23, 2024
48b36c9
update python versions, dependencies versions
erexer Oct 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 22 additions & 21 deletions docs/source/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,12 @@ We introduce a metric named Net Locational Cost (NLC) that is used compete power
Python version support
----------------------

Officially Python 3.7, 3.8, and 3.9
Officially Python 3.9, 3.10, and 3.11.


Installation
------------

.. note::

**cerf** is not officially supported for Ubuntu 18 users due to a system dependency (``GLIBC_2.29``) required by the ``whitebox`` package which **cerf** uses to conduct spatial analysis. Ubuntu 18 natively includes ``GLIBC_2.27``. It may be possible for Ubuntu 18 users to upgrade to ``GLIBC_2.29`` but this should be done with careful consideration. Instead, we officially support **cerf** use for Ubuntu users for versions 20.04.2 LTS and greater.

**cerf** can be installed via pip by running the following from a terminal window::

pip install cerf
Expand Down Expand Up @@ -59,36 +55,41 @@ Dependencies
Dependency Minimum Version
============= ================
numpy 1.19.4
scipy 1.12
pyarrow 17.0.0
pandas 1.1.4
rasterio 1.2.3
xarray 0.16.1
rioxarray 0.15
PyYAML 5.4.1
requests 2.25.1
joblib 1.0.1
matplotlib 3.3.3
seaborn 0.11.1
whitebox 1.5.1
fiona 1.8.19
pyproj 3.0.1
rtree 0.9.7
shapely 1.7.1
shapely 1.7
geopandas 0.9.0
============= ================


Optional dependencies
---------------------

================== ================
Dependency Minimum Version
================== ================
build 0.5.1
nbsphinx 0.8.6
setuptools 57.0.0
sphinx 4.0.2
sphinx-panels 0.6.0
sphinx-rtd-theme 0.5.2
twine 3.4.1
pytest 6.2.4
pytest-cov 2.12.1
================== ================
================== ================
Dependency Minimum Version
================== ================
setuptools 57.0.0
build 0.5.1
ipykernel 6.15.1
autodoc 0.5.0
nbsphinx 0.8.6
sphinx 7.2.6
sphinx-design 0.5.0
sphinx-rtd-theme 2.0.0
sphinx-mathjax-offline 0.0.2
sphinx-panels 0.6.0
twine 4.0.1
pytest 6.0
pytest-cov 2.12.1
================== ================
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ name = "cerf"
description = "An open-source geospatial Python package for assessing and analyzing future electricity technology capacity expansion feasibility."
readme = "README.md"
version = "2.4.0"
requires-python = ">=3.9"
requires-python = ">=3.9,<3.12"
license = {file = "LICENSE"}
authors = [
{name = "Chris Vernon", email = "[email protected]"},
Expand Down