diff --git a/docs/source/install.rst b/docs/source/install.rst index 8e29f62..4e50240 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -2,6 +2,14 @@ Install MILES GUESS =================== + +MILES GUESS supports Python 3.8 to 3.11. Support +for newer versions of Python depends on the choice +of deep learning model backend. + +The primary ML library dependency is keras 3. Install one +of the keras 3 backends (tensorflow, pytorch, or jax). + First, set up a base Python environment on your system. We highly recommend using miniconda or mambaforge to easily install all the dependencies. @@ -9,12 +17,14 @@ mambaforge to easily install all the dependencies. To install the stable version of the package: .. code-block:: bash + pip install miles-guess To use the latest developed version of the package, first download : .. code-block:: bash + git clone git@github.com:ai2es/miles-guess.git cd miles-guess @@ -23,17 +33,20 @@ Next, build the environment for the package. For CPU-based systems: .. code-block:: bash + mamba env create -f environment.yml For GPU-based systems: .. code-block:: bash + mamba env create -f environment_casper.yml If you want to install miles-guess directly after building your environment run: .. code-block:: bash + pip install . Keras 3 Installation @@ -47,6 +60,7 @@ this issue, reinstall keras 3 by running the following command: .. code-block:: bash + pip install --upgrade keras diff --git a/environment.yml b/environment.yml index d47f0cd..f3b8769 100644 --- a/environment.yml +++ b/environment.yml @@ -2,7 +2,7 @@ name: guess channels: - conda-forge dependencies: - - python=3.10 + - python=3.11 - numpy<1.24 - scipy - matplotlib diff --git a/environment_casper.yml b/environment_casper.yml index 64debc4..0563423 100644 --- a/environment_casper.yml +++ b/environment_casper.yml @@ -3,7 +3,7 @@ channels: - conda-forge - nvidia dependencies: - - python=3.10 + - python=3.11 - numpy=1.23.* - scipy - matplotlib diff --git a/pyproject.toml b/pyproject.toml index 7008802..67f0267 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "miles-guess" -authors = [{name = "John Schreck, David John Gagne, Charlie Becker, Gabrielle Gantos", email = "miles@ucar.edu"}] +authors = [{name = "John Schreck, David John Gagne, Charlie Becker, Gabrielle Gantos", email = "milescore@ucar.edu"}] readme = "README.md" license = {file = "LICENSE"} dynamic = ["version"] @@ -36,12 +36,14 @@ dependencies = [ ] [project.optional-dependencies] -tensorflow = ["tensorflow>=2.12"] +tensorflow = ["tensorflow==2.16.0rc0"] -tensorflow_gpu = ["tensorflow[and-cuda]"] +tensorflow_gpu = ["tensorflow[and-cuda]==2.16.0rc0"] torch = ["torch"] +jax = ["jax"] + [tool.setuptools]