Skip to content

Commit

Permalink
Add note to windows installation via poetry
Browse files Browse the repository at this point in the history
  • Loading branch information
luisaforozco committed Mar 19, 2024
1 parent 4e8f7e9 commit c932283
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Browse to the [GrainLearning documentation](https://grainlearning.readthedocs.io

1. Clone the repository: `git clone https://github.com/GrainLearning/grainLearning.git`
1. Go to the source code directory: `cd grainLearning`
1. Activate the virtual environment: `conda create --name grainlearning python=3.8 && conda activate grainlearning`
1. Activate the virtual environment: `conda create --name grainlearning python=3.11 && conda activate grainlearning`
1. Install GrainLearning and its dependencies: `pip install .`

__Developers__ please refer to [README.dev.md](README.dev.md).
Expand Down
8 changes: 5 additions & 3 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Installation
============

GrainLearning can be installed with poetry and pip, on Windows, Mac, and Linux OS, with a Python version higher than 3.8.
We have tested GrainLearning with Python versions 3.8, 3.9, and 3.10.
GrainLearning can be installed with poetry and pip, on Windows, Mac, and Linux OS, with a Python version higher than 3.9.
We have tested GrainLearning with Python versions 3.9, 3.10, and 3.11.

Package management and dependencies
-----------------------------------
Expand Down Expand Up @@ -30,6 +30,8 @@ First, install poetry following `these instructions <https://python-poetry.org/d
# You are done. Try any examples in the ./tutorials directory
poetry run python <example.py>
.. note:: In windows systems, if you experience problems installing `tensorflow` using poetry, try using pip.

Install using pip
`````````````````

Expand Down Expand Up @@ -106,7 +108,7 @@ Online
You can check the online documentation `here <https://grainlearning.readthedocs.io/en/latest/>`_.

Build the documentation locally
```````````````````````
```````````````````````````````

.. code-block:: bash
Expand Down

0 comments on commit c932283

Please sign in to comment.