Skip to content

Commit

Permalink
Updated docs and environment.
Browse files Browse the repository at this point in the history
  • Loading branch information
djgagne committed Feb 29, 2024
1 parent 9742964 commit 34493f3
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 5 deletions.
14 changes: 14 additions & 0 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,29 @@
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.

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 [email protected]:ai2es/miles-guess.git
cd miles-guess
Expand All @@ -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
Expand All @@ -47,6 +60,7 @@ this issue, reinstall keras 3 by running the
following command:

.. code-block:: bash
pip install --upgrade keras
Expand Down
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: guess
channels:
- conda-forge
dependencies:
- python=3.10
- python=3.11
- numpy<1.24
- scipy
- matplotlib
Expand Down
2 changes: 1 addition & 1 deletion environment_casper.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ channels:
- conda-forge
- nvidia
dependencies:
- python=3.10
- python=3.11
- numpy=1.23.*
- scipy
- matplotlib
Expand Down
8 changes: 5 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down Expand Up @@ -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]
Expand Down

0 comments on commit 34493f3

Please sign in to comment.