Skip to content

Commit

Permalink
added venv to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shimwell committed Jan 5, 2025
1 parent d6242ab commit fc427b2
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions docs/install.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
Install
=======

You might wish to create a virtual environment to install Paramak into. This can be done using the venv module in Python. For more information, see the `official Python documentation <https://docs.python.org/3/library/venv.html>`_.

.. code-block:: bash
python -m venv paramak-venv
source paramak-venv/bin/activate
Paramak is distributed via `PyPI <https://pypi.org/project/paramak/>`_ and can be installed using pip.

.. code-block:: bash
pip install paramak
python -m pip install paramak
.. Prerequisites
Expand All @@ -31,7 +40,7 @@ Paramak is distributed via `PyPI <https://pypi.org/project/paramak/>`_ and can b
.. .. code-block:: bash
.. mamba create --name paramak_env python=3.11
.. mamba create --name paramak_env python=3.12
.. Then activate the new environment.
Expand All @@ -56,7 +65,7 @@ Paramak is distributed via `PyPI <https://pypi.org/project/paramak/>`_ and can b
.. .. code-block:: bash
.. conda create --name paramak_env python=3.11
.. conda create --name paramak_env python=3.12
.. Then activate the new environment.
Expand All @@ -78,11 +87,12 @@ Paramak is distributed via `PyPI <https://pypi.org/project/paramak/>`_ and can b
Developer Installation
----------------------

If you want to contribute to the paramak or then you might want to install the
package in a more dynamic manner so that your changes to the code are readily available.
If you want to contribute to Paramak or then you might want to install the
package in a more dynamic manner so that your changes to the code are readily
available.

Download and install MiniConda, create a new python environment and activate the
environment as covered in the installation procedure above.
Create a new Venv, Conda or Mamba virtual environment and activate the
environment as covered in the installation procedure above

Then clone the repository

Expand Down

0 comments on commit fc427b2

Please sign in to comment.